summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/filehook/filehook.dtx
blob: 35398cb4fe1c4024f7e8591fcd21a63f5bf1cee3 (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
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
% \iffalse meta-comment
%% Copyright (c) 2010-2011 by Martin Scharrer <martin@scharrer-online.de>
%% -----------------------------------------------------------------
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3c
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%
%%   http://www.latex-project.org/lppl.txt
%%
%% and version 1.3c or later is part of all distributions of LaTeX
%% version 2008/05/04 or later.
%%
%% This work has the LPPL maintenance status `maintained'.
%%
%% The Current Maintainer of this work is Martin Scharrer.
%%
%% This work consists of the files filehook.dtx, filehook.ins
%% and the derived file filehook.sty.
%%
%% $Id: filehook.dtx 2005 2011-01-03 22:53:56Z martin $
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{filehook.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{filehook}
%<*package>
    [2011/01/03 v0.4 Hooks for input files]
%</package>
%
%<*driver>
\documentclass{ydoc}[2011/01/03]
\usepackage{filehook}[2011/01/03]
\usepackage{ifpdf}
\usepackage{hyperref}
\usepackage{array}
\usepackage{booktabs}
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\providecommand*\pkg{\texttt}
\makeatletter
\providecommand*\tablecaption{%
    \@tempdima=\abovecaptionskip
    \abovecaptionskip=\belowcaptionskip
    \belowcaptionskip=\@tempdima
    \caption
}
\makeatother
\listfiles
\begin{document}
  \DocInput{filehook.dtx}
  \PrintChanges
  \PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{939}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
%
% \changes{v0.1}{2010/04/08}{Initial version}
% \changes{v0.2}{2010/12/08}{Added support for 'memoir' class and 'scrlfile' package. Remove support for deprecated 'fink' package.}
% \changes{v0.3}{2010/12/20}{Added hooks for package and class files. Changed a warning to an error and added the 'force' option to overwrite this.}
% \changes{v0.4}{2011/01/03}{^^A
% Improved support for 'memoir' class and 'scrlfile' package.
% Added AtBeginOfEveryFile and AtEndOfEveryFile hooks.
% Changed handling of macro arguments in hook code.
% Added filename parsing code to support TeX files with and without extension.
% Added AtBeginOfEveryFile/AtEndOfEveryFile hooks.
% Fixes misspelled \string\AfterOfIncludeFile.
% Added patch for listings \lstinputlistings to avoid hooks for verbatim files.
% Added star argument for AtBeginOfClass and PackageFile.
% Worked on scrlfile and memoir compatibility.
% Readded fink compatibility code.
% Updated documentation.
% }
%
% \GetFileInfo{filehook.dtx}
%
% \DoNotIndex{\newcommand,\newenvironment}
%
% \ifpdf
% \hypersetup{%
%   pdfauthor   = {Martin Scharrer <martin@scharrer-online.de>},
%   pdftitle    = {The filehook package},
%   pdfsubject  = {Documentation of LaTeX package 'filehook'},
%   pdfkeywords = {current filename, filename, file, name, LaTeX, TeX}
% }%
% \fi
% \clearpage
% \null
% \vspace*{-2em}
% \begin{center}
%   {\LARGE\sffamily The \emph{filehook} Package\\[\medskipamount]}
%   {\large Martin Scharrer \\[\medskipamount]\normalsize 
%   \url{martin@scharrer-online.de}\\[.8ex]
%   \url{http://www.ctan.org/pkg/filehook/}\\[\bigskipamount]}
%   {\large Version \fileversion\ -- \filedate}\\
% \end{center}
% \vspace{1.2em}%
%
% \begin{abstract}
% This package provides hooks for input files. Document and package authors can use these hooks to
% execute code at begin or the end of specific or all input files.
% \end{abstract}
%
%
% \section{Introduction}
% These package changes some internal \LaTeX{} macros used to load input files so that they include `hooks'.
% A hook is an (internal) macro executed at specific points. Normally it is initially empty, but can be extended using
% an user level macro. The most common hook in \LaTeX{} is the `At-Begin-Document' hook. Code can be added to this hook
% using \Macro\AtBeginDocument{<\TeX code>}.
%
%
% This package provides hooks for files read by the \LaTeX{} macros \Macro\input, \Macro\include and 
% \Macro\InputIfFileExists as well as (since v0.3 from 2010/12/20) for class and package files, 
% i.e. macros \Macro\documentclass, \Macro\LoadClassWithOptions and \Macro\LoadClass
% as well as \Macro\usepackage, \Macro\RequirePackageWithOptions and \Macro\RequirePackage.
% Note that \Macro\InputIfFileExists, and therefore its hooks, is used by the aforementioned macros.
% In v0.4 from 2011/03/01 special hooks where added which are executed for every read file, but will not be
% executed a second time by the internal \Macro\InputIfFileExists inside \Macro\input and \Macro\include.
%
% For all files a `AtBegin' and a `AtEnd' hook is installed. For \Macro\include files there is also a `After' hook which
% it is executed \emph{after} the page break (\Macro\clearpage) is inserted by the \Macro\include code.
% In contrast, the `AtEnd' hook is executed before the trailing page break 
% and the `AtBegin' hook is executed after the \emph{leading} page break.
% The `AtBegin' hook can be used to set macros to file specific values.
% These macros can be reset in the `AtEnd' hook to the parent file values.
% If these macros appear in the page header or footer they need to be reset `After' hook
% to ensure that the correct values are used for the last page.
%
% In addition to general hooks which are executed for all files of there type,
% file specific one can be defined which are only executed for the named file.
% The hooks for classes and packages are always specific to one file.
%
% Older versions of this package provided the file name as argument |#1| for the general hooks.
% This has been changed in v0.4 from 2011/01/03: the hook code is stored and executed without modifications,
% i.e.\ macro argument characters (|#|) are now handled like normal and don't have to be doubled.
% See section~\ref{sec:upgrade} for information how to upgrade older documents.
%
% \section{Usage}
% The below macros can be used to add material (\TeX{} code) to the related hooks.
% All `AtBegin' macros will \emph{append} the code to the hooks, but the `AtEnd' and `After' macros will \emph{prefix} the code instead.
% This ensures that two different packages adding material in `AtBegin'/`AtEnd' pairs do not overlap each other.
% Instead the later used package adds the code closer to the file content, `inside' the material added by the first package.
% Therefore it is safely possible to surround the content of a file with multiple \LaTeX{} environments using multiple `AtBegin'/`AtEnd' macro calls.
% If required inside another package a different order can be enforced by using the internal hook macros shown in the implementation section.
%
%^^A Some internal macros to draw the hook positions:
% \def\Hook#1{\textsf{Hook: #1}\MacroArgs}
%
% \def\DrawInputIfB#1{%
% \hbox{\vbox{%
%   \sffamily
%   \hbox{\Macro\InputIfFileExists:}%
%   \hbox{\fbox{\vbox{%
%     \hbox{\Hook{AtBeginOfFile}{<file name>}}%
%     #1%
%     \hbox{\Hook{AtBeginOfFiles}}%
%     \hbox{\fbox{\emph{Content}}}%
%     \vspace{2pt}%
%     \hbox{\Hook{AtEndOfFiles}}%
%     \hbox{\Hook{AtEndOfFile}{<file name>}}%
%   }}}%
% }}%
% }%
% 
% \def\DrawInputIf#1{%
% \hbox{\vbox{%
%   \sffamily
%   \hbox{\Macro\InputIfFileExists:}%
%   \hbox{\fbox{\vbox{%
%     \hbox{\Hook{AtBeginOfEveryFile}}%
%     \hbox{\Hook{AtBeginOfFile}{<file name>}}%
%     #1%
%     \hbox{\Hook{AtBeginOfFiles}}%
%     \hbox{\fbox{\emph{Content}}}%
%     \vspace{2pt}%
%     \hbox{\Hook{AtEndOfFiles}}%
%     \hbox{\Hook{AtEndOfFile}{<file name>}}%
%     \hbox{\Hook{AtEndOfEveryFile}}%
%   }}}%
% }}%
% }%
%
%
% \subsection*{Every File}
%
% \DescribeMacro{\AtBeginOfEveryFile}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfEveryFile}{<\TeX\ code>}
% Sometime certain code should be executed at the begin and end of every read file, e.g.\ pushing and popping a file stack.
% The `At...OfFiles' hooks already do a good job here. Unfortunately there is the issue with the \Macro\clearpage in \Macro\include.
% The \Macro\AtEndOfFiles is executed before it, which can cause issues with page headers and footers.
% A workaround, e.g.\ done by older versions of the \pkg{currfile} package, is to execute the code twice for include files:
% once in the |include| related hooks and once in the |OfFiles| hooks.
%
% A better solution for this problem was added in v0.4 from 2011/01/03:
% the |EveryFile| hooks will be executed exactly once for every file, independent if it is
% read using \Macro\input, \Macro\include or \Macro\InputIfFileExists.
% Special care is taken to suppress them for the \Macro\InputIfFileExists inside \Macro\input and \Macro\include.
%
% These hooks are located around the more specific hooks:
% For \Macro\input files the `Begin' hook is executed before the \Macro\AtBeginOfInputs hook and the `End' hook after
% the \Macro\AtEndOfInputs.
% Similarly, for \Macro\include files the `Begin' hook is executed before the \Macro\AtBeginOfIncludes hook and the `End' hook after
% the \Macro\AfterIncludes (!).
% For files read by \Macro\InputIfFileExists (e.g. also for \Macro\usepackage, etc.) they are executed before and after the
% \Macro\AtBeginOfFiles and \Macro\AtEndOfFiles hooks, respectively.
% Note that the \Macro\AtBeginOfEveryFile hook is executed before the \Macro\AtBeginOfPackageFile/\Macro\AtBeginOfClassFile hooks
% and that the \Macro\AtEndOfEveryFile hook is executed also before the hooks \Macro\AtEndOfPackageFile/\Macro\AtEndOfClassFile.
% Therefore the `Every' and `PackageFile'/`ClassFile' hooks do not nest correctly like all other hooks do.
%
%
% \subsection*{All Files}
%
% \DescribeMacro{\AtBeginOfFiles}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfFiles}{<\TeX\ code>}
% These macros add the given \marg{code} to two hooks executed for all files read using the \Macro\InputIfFileExists macro. This macro is used internally by the 
% \Macro\input, \Macro\include and \Macro\usepackage/\Macro\RequirePackage macros. Packages and classes might use it to include additional or auxiliary files.
% Authors can exclude those files from the hooks by using \Macro\IfFileExists{<file name>}|{\@input\@filef@und}{}| instead.
%
% \DescribeMacro{\AtBeginOfFile}{<file name with extension>}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfFile}{<file name with extension>}{<\TeX\ code>}
% Like the {\Macro{...OfIncludeFile}{<file name>}{<\TeX\ code>}} macros above, just for `all' read files. Here the \meta{file name} should include the file
% extension!
%
% The `all files' hooks are closer to the file content than the \Macro\input and \Macro\include hook, i.e.\ the \Macro\AtBeginOfFiles comes \emph{after} the \Macro\AtBeginOfIncludes and
% the \Macro\AtEndOfFiles comes \emph{before} the \Macro\AtEndOfIncludes hook.
%
% The following figure shows the positions of the hooks inside the macro:\par\medskip
% \centerline{\DrawInputIf{}}
%
%
% \subsection*{Include Files}
% \DescribeMacro{\AtBeginOfIncludes}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfIncludes}{<\TeX\ code>}
% \DescribeMacro{\AfterIncludes}{<\TeX\ code>}
% As described above the `AtEnd' hook is executed before and the `After' hook is executed after the trailing \Macro\clearpage.
% Note that material which appears in the page header or footer should be updated in the `After' hook, not the `AtEnd' hook, to ensure
% that the old values are still valid for the last page.
%
% \DescribeMacro{\AtBeginOfIncludeFile}{<file name>}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfIncludeFile}{<file name>}{<\TeX\ code>}
% \DescribeMacro{\AfterIncludeFile}{<file name>}{<\TeX\ code>}
% These file-specific macros take the two arguments. The \meta{code} is only executed for the file with the given \meta{file name}
% and only if it is read using \Macro\include.
% The \meta{file name} should be identical to the name used for \Macro\include and not include the `|.tex|' extension.
%
% The following figure shows the positions of the hooks inside the macro:\par\medskip
% \centerline{\hbox{\vbox{%
%   \sffamily
%   \hbox{\Macro\include:}%
%   \hbox{\fbox{\vbox{%
%    \hbox{\Macro\clearpage~~(implicit)}%
%    \hbox{\Hook{AtBeginOfEveryFile}}%
%    \hbox{\Hook{AtBeginOfIncludeFile}{<file name>}}%
%    \hbox{\Hook{AtBeginOfIncludes}}%
%    \hbox{\fbox{\DrawInputIfB{}}}%
%    \vspace{2pt}%
%    \hbox{\Hook{AtEndOfIncludes}}%
%    \hbox{\Hook{AtEndOfIncludeFile}{<file name>}}%
%    \hbox{\Macro\clearpage~~(implicit)}%
%    \hbox{\Hook{AfterIncludes}}%
%    \hbox{\Hook{AfterIncludeFile}{<file name>}}%
%    \hbox{\Hook{AtEndOfEveryFile}}%
%   }}}%
% }}}
%
%
% \subsection*{Input Files}
%
% \DescribeMacro{\AtBeginOfInputs}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfInputs}{<\TeX\ code>}
% Like the \Macro{...OfIncludes}{code} macros above, just for file read using \Macro\input.
%
% \DescribeMacro{\AtBeginOfInputFile}{<file name>}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfInputFile}{<file name>}{<\TeX\ code>}
% Like the \Macro{...OfIncludeFile}{<file name>}{code} macros above, just for file read using \Macro\input. Here the \meta{file name} should include the file
% extension!
%
% The following figure shows the positions of the hooks inside the macro:\par\medskip
% \centerline{\hbox{\vbox{%
%   \sffamily
%   \hbox{\Macro\input:}%
%   \hbox{\fbox{\vbox{%
%    \hbox{\Hook{AtBeginOfEveryFile}}%
%    \hbox{\Hook{AtBeginOfInputFile}{<file name>}}%
%    \hbox{\Hook{AtBeginOfInputs}}%
%    \hbox{\fbox{\DrawInputIfB{}}}%
%    \vspace{2pt}%
%    \hbox{\Hook{AtEndOfInputs}}%
%    \hbox{\Hook{AtEndOfInputFile}{<file name>}}%
%    \hbox{\Hook{AtEndOfEveryFile}}%
%   }}}%
% }}}
%
%
%
% \subsection*{Package Files}
%
% \DescribeMacro{\AtBeginOfPackageFile}*{<package name>}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfPackageFile}*{<package name>}{<\TeX\ code>}
% This macros install the given \MacroArgs<\TeX\ code> in the `AtBegin' and `AtEnd' hooks of the given package file.
% The \Macro\AtBeginOfPackageFile simply executes \Macro\AtBeginOfFile{<package name>.sty}{<\TeX code>}.
% Special care is taken to ensure that the `AtEnd' code is executed \emph{after} any code installed by the package itself
% using the \LaTeX\ macro \Macro\AtEndOfPackage.
% If the starred version is used and the package is already loaded the code
% is executed right away.
%
% The following figure shows the positions of the hooks inside the macros:\par\medskip
% \centerline{\hbox{\vbox{%
%   \sffamily
%   \hbox{\Macro\usepackage/\Macro\RequirePackage/\Macro\RequirePackageWithOptions:}%
%   \hbox{\fbox{\vbox{%
%    \hbox{\fbox{\DrawInputIf{\hbox{ (includes AtBeginOfPackageFile\MacroArgs{<file name>})}}}}%
%    \vspace{2pt}%
%    \hbox{\Hook{AtEndOfPackage}~~(\LaTeX\ hook)}%
%    \hbox{\Hook{AtEndOfPackageFile}{<file name>}}%
%   }}}%
% }}}
%
% \subsection*{Class Files}
%
% \DescribeMacro{\AtBeginOfClassFile}*{<class name>}{<\TeX\ code>}
% \DescribeMacro{\AtEndOfClassFile}*{<class name>}{<\TeX\ code>}
% This macros install the given \MacroArgs<\TeX\ code> in the `AtBegin' and `AtEnd' hooks of the given class file.
% They work with classes loaded using \Macro\LoadClass, \Macro\LoadClassWithOptions and also \Macro\documentclass.
% However, in the latter case |filehook| must be loaded using \Macro\RequirePackage beforehand.
% The macro \Macro\AtBeginOfClassFile simply executes \Macro\AtBeginOfFile{<class name>.cls}{\ldots}.
% Special care is taken to ensure that the `AtEnd' code is executed \emph{after} any code installed by the class itself
% using the \LaTeX\ macro \Macro\AtEndOfClass.
% If the starred version is used and the class is already loaded the code
% is executed right away.
%
% The following figure shows the positions of the hooks inside the macros:\par\medskip
% \centerline{\hbox{\vbox{%
%   \sffamily
%   \hbox{\Macro\documentclass/\Macro\LoadClass/\Macro\LoadClassWithOptions:}%
%   \hbox{\fbox{\vbox{%
%    \hbox{\fbox{\DrawInputIf{\hbox{ (includes AtBeginOfClassFile\MacroArgs{<file name>})}}}}%
%    \vspace{2pt}%
%    \hbox{\Hook{AtEndOfClass}~~(\LaTeX\ hook)}%
%    \hbox{\Hook{AtEndOfClassFile}{<file name>}}%
%   }}}%
% }}}
%
%
% \clearpage
% \section{Compatibility Issues with Classes and other Packages}
% The |filehook| package might clash with other packages or classes which also redefine \Macro\InputIfFileExists
% or internal macros used by \Macro\include and \Macro\input (which are \Macro\@input@ and \Macro\@iinput).
% Special compatibility code is in place for the packages listed below (in their current implementation).
% If any other unknown definition of \Macro\InputIfFileExists is found an error will be raised.
% The package option `|force|' can be used to prevent this and to force the redefinition of this macro.
% Then any previous modifications will be lost, which will most likely break the other package.
% Table~\ref{tab:incomp} lists all packages and classes which where found do be incompatible.
% The packages \pkg{auxhook}, \pkg{stampinclude}, \pkg{rerunfilecheck} and \pkg{excludeonly} redefine
% one or more of the above macros but have been found compatible with |filehook|.
% Please do not hesitate to inform the author of |filehook| of any encountered problems with other packages.
%
% \subsection{Supported Classes and Packages}
% The following classes and packages are actively supported and should work as normal when used together with |filehook|.
% Please note that most of them are incompatible to each other, which |filehook| might not fix.
%
% \subsubsection*{memoir}
% The |memoir| class redefines \Macro\InputIfFileExists to add own hooks identical to the `At...OfFiles' hooks (there called \Macro\AtBeginFile and \Macro\AtEndFile).
% This hooks will be moved to the corresponding ones of |filehook| and will keep working as normal.
% Since v0.4 from 2011/01/03 this modification will be also applied when the |filehook| package is loaded (using \Macro\RequirePackage) \emph{before} the
% |memoir| class. However, the hooks from |filehook| need to be temporally disabled while reading the |memoir| class.
% They will not be triggered for all files read directly by this class, like configuration and patch files.
% Note that the `At...OfClassFile' hooks still work for the |memoir| class file itself. In fact they are used to restore the default definition of \Macro\InputIfFileExists
% at the begin and patch it at the end of the class file.
% The |filehook| package should be loaded either before the class (using \Macro\RequirePackage) or directly
% after it. Because the |memoir| hook code is moved to the |filehook| hooks this class should then be
% compatible with below packages if |memoir| and |filehook| are loaded before them.
%
%
% \subsubsection*{scrlfile}
% The |scrlfile| package from the \emph{koma-script} bundle redefines \Macro\InputIfFileExists to allow file name aliases and to also add hooks.
% If required it should be loaded before |filehook|, which will add its hooks correctly to the modified definition.
% Since v0.4 from 2011/01/03 this modification will be also applied when the |scrlfile| package is loaded after |filehook|.
%
%
% \subsubsection*{fink}
% The |filehook| and |currfile| packages where written as replacements for the |fink| package, where |filehook| provides the necessary hooks for |currfile|.
% The |fink| package has now been deprecated in favour of |currfile| and should not be used anymore. The |fink| compatibility code has been removed from |filehook|
% and both cannot be used successfully together as both redefine the \Macro\InputIfFileExists macro.
%
%
% \subsubsection*{listings}
% The \pkg{listings} package uses \Macro\input inside \Macro\lstinputlisting. Therefore the |InputFile|(|s|) and |File|(|s|) hooks are also triggered for these files.
% Please note that this hooks are executing inside a verbatim environment. While the code in the hook is not affected (because it was added outside the verbatim
% environment), any further code read using any input macro (\Macro\input, \Macro\@input, \Macro\@@input (\TeX's \Macro\input), \ldots) will be processed verbatim and typeset
% as part of the listing. 
% Since v0.4 this macro is automatically patched so \Macro\@input is used instead to avoid this issue.
%
%
% \subsection{Other Classes and Packages}
%
% \subsubsection*{jmlrbook}
% The |jmlrbook| class from the |jmlr| bundle temporary redefines \Macro\InputIfFileExists to import papers.
% The `original' definition is saved away at load time of the package and is used internally by the new definition.
% This means that the hooks will not be active for this imported files because |filehook| is loaded after the class.
% This should not affect its normal usage.
% Note that, in theory, the package could be loaded before \Macro\documentclass using \Macro\RequirePackage to enable the file hooks also for these files.
%
% \subsubsection*{\LaTeX's \textbackslash bibliography}
% The standard \LaTeX\ macro \Macro\bibliography uses the same internal macro \Macro\@input@ to read a file
% as \Macro\include does.
% The `include' hooks will also be executed for this |.bbl| file if the macro is directly followed by \Macro\clearpage,
% because the |filehook| code will assume it is executed inside \Macro\include.
% This rare case can be easily avoided by placing a \Macro\relax after \Macro\bibliography{\ldots}.
%
%
% \begin{table}
%    \centering
%    \tablecaption{Incompatible packages and classes}
%    \label{tab:incomp}
%
%    \begin{tabular}{>{\ttfamily}llll}
%       \toprule
%       Name     & Type    &  Note                          &  Affected Hooks  \\
%       \midrule
%       paper    & class   &  with \texttt{journal} option  &  All hocks for \Macro\include\unskip'd files \\
%       journal  & class   &                                &  All hocks for \Macro\include\unskip'd files \\
%       gmparts  & package &                                &  \Macro\include hooks                        \\
%       newclude & package & formally \texttt{includex}     &  All hocks for \Macro\include\unskip'd files \\
%       \bottomrule
%    \end{tabular}
% \end{table}
%
% \clearpage
% \section{Upgrade Guide}
% \label{sec:upgrade}
% This sections gives information for users of older versions of this package which unfortunately might not be 100\% backwards compatible.
%
% \subsection*{Upgrade to v0.4 - 2011/01/03}
% \begin{itemize}
%   \item The macro \Macro\AfterIncludeFile was misspelled as \Macro\AfterOfIncludeFile in the implementation of earlier versions, but not in the documentation.
%   This has now be corrected. Please adjust your code to use the correct name and to require the |filehook| package from 2011/01/03.
%   \item All general hooks (the one not taking a file argument) used to have an implicit argument |#1| which was expanded to the file name (i.e.\ the argument of \Macro\input etc.).
%    This has now be changed, so that macro arguments are not handled special in hook code, which e.g.\ simplifies macro definitions.
%    Older hook code might need to change |##| to |#| to compensate for this change.
%    If the file name is required the macros (e.g.\ \Macro\currfilename) of the partner package \pkg{currfile} should be used.
%    These macros are available everywhere including in all hocks.
% \end{itemize}
%
% \StopEventually{}
% \clearpage
% \section{Implementation}\label{sec:impl}
%
% \iffalse
%<*package>
% \fi
%
% \subsection{Options}
%    \begin{macrocode}
\newif\iffilehook@force
\DeclareOption{force}{\filehook@forcetrue}
\ProcessOptions\relax
%    \end{macrocode}
%
%
%
% \subsection{Initialisation of Hooks}
% The general hooks are initialised to call the file specific hooks.
%
% \begin{macro}{\filehook@include@atbegin}
%    \begin{macrocode}
\def\filehook@include@atbegin#1{%
  \let\InputIfFileExists\filehook@@InputIfFileExists
  \@nameuse{\filehook@include@atbegin@#1}%
  \filehook@include@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@include@@atbegin}
%    \begin{macrocode}
\def\filehook@include@@atbegin{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@include@atend}
%    \begin{macrocode}
\def\filehook@include@atend#1{%
  \filehook@include@@atend
  \@nameuse{\filehook@include@atend@#1}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@include@@atend}
%    \begin{macrocode}
\def\filehook@include@@atend{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@include@after}
%    \begin{macrocode}
\def\filehook@include@after#1{%
  \filehook@include@@after
  \@nameuse{\filehook@include@after@#1}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@include@@after}
%    \begin{macrocode}
\def\filehook@include@@after{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@input@atbegin}
%    \begin{macrocode}
\def\filehook@input@atbegin#1{%
  \let\InputIfFileExists\filehook@@InputIfFileExists
  \@nameuse{\filehook@input@atbegin@\filehook@ensureext{#1}}%
  \filehook@input@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@input@@atbegin}
%    \begin{macrocode}
\def\filehook@input@@atbegin{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@input@atend}
%    \begin{macrocode}
\def\filehook@input@atend#1{%
  \filehook@input@@atend
  \@nameuse{\filehook@input@atend@\filehook@ensureext{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@input@@atend}
%    \begin{macrocode}
\def\filehook@input@@atend{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@atbegin}
%    \begin{macrocode}
\def\filehook@atbegin#1{%
  \@nameuse{\filehook@atbegin@\filehook@ensureext{#1}}%
  \filehook@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@atbegin}
%    \begin{macrocode}
\def\filehook@@atbegin{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@atend}
%    \begin{macrocode}
\def\filehook@atend#1{%
  \filehook@@atend
  \@nameuse{\filehook@atend@\filehook@ensureext{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@atend}
%    \begin{macrocode}
\def\filehook@@atend{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@every@atbegin}
%    \begin{macrocode}
\def\filehook@every@atbegin#1{%
    \filehook@every@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@every@@atbegin}
%    \begin{macrocode}
\def\filehook@every@@atbegin{}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@every@atend}
%    \begin{macrocode}
\def\filehook@every@atend#1{%
    \filehook@every@@atend
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@every@@atend}
%    \begin{macrocode}
\def\filehook@every@@atend{}
%    \end{macrocode}
% \end{macro}
%
%
%
% \subsection{Hook Modification Macros}
% The following macros are used to modify the hooks, i.e.\ to prefix or append code to them.
%
%
% \subsubsection*{Internal Macros}
%
% The macro prefixes for the file specific hooks are stored in macros to reduce the number of 
% tokens in the following macro definitions.
%    \begin{macrocode}
\def\filehook@include@atbegin@{filehook@include@atbegin@}
\def\filehook@include@atend@{filehook@include@atend@}
\def\filehook@include@after@{filehook@include@after@}
\def\filehook@input@atbegin@{filehook@input@atbegin@}
\def\filehook@input@atend@{filehook@input@atend@}
\def\filehook@input@after@{filehook@input@after@}
\def\filehook@atbegin@{filehook@atbegin@}
\def\filehook@atend@{filehook@atend@}
\def\filehook@after@{filehook@after@}
%    \end{macrocode}
%
%
% \begin{macro}{\filehook@append}
% Uses default \LaTeX{} macro.
%    \begin{macrocode}
\def\filehook@append{\g@addto@macro}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@appendwarg}
% Appends code with one macro argument. The |\@tempa| intermediate step is required because of the
% included |##1| which wouldn't correctly expand otherwise.
%    \begin{macrocode}
\long\def\filehook@appendwarg#1#2{%
  \begingroup
    \toks@\expandafter{#1{##1}#2}%
    \edef\@tempa{\the\toks@}%
    \expandafter\gdef\expandafter#1\expandafter##\expandafter1\expandafter{\@tempa}%
  \endgroup
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@prefix}
% Prefixes code to a hook.
%    \begin{macrocode}
\long\def\filehook@prefix#1#2{%
  \begingroup
    \@temptokena{#2}%
    \toks@\expandafter{#1}%
    \xdef#1{\the\@temptokena\the\toks@}%
  \endgroup
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@prefixwarg}
% Prefixes code with an argument to a hook.
%    \begin{macrocode}
\long\def\filehook@prefixwarg#1#2{%
  \begingroup
    \@temptokena{#2}%
    \toks@\expandafter{#1{##1}}%
    \edef\@tempa{\the\@temptokena\the\toks@}%
    \expandafter\gdef\expandafter#1\expandafter##\expandafter1\expandafter{\@tempa}%
  \endgroup
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@addtohook}[3]{Macro which should be used to add the material to the hook}{Macro name prefix}{End of macro name (file name)}
% The macro first expands the file name (|#3|) to flatten all included macros. An extension is added if missing, as well as the prefix.
% All modifications of |\@tempa| are made inside a group to keep them local.
%    \begin{macrocode}
\def\filehook@addtohook#1#2#3{%
  \begingroup
  \edef\@tempa{#3}%
  \edef\@tempa{#2\filehook@ensureext{\@tempa}}%
  \@ifundefined{\@tempa}{\global\@namedef{\@tempa}{}}{}%
  \expandafter\endgroup
  \expandafter#1\csname\@tempa\endcsname
}
%    \end{macrocode}
% \end{macro}
%
% \subsubsection*{User Level Macros}
% The user level macros simple use the above defined macros on the appropriate hook.
%
% \begin{macro}{\AtBeginOfIncludes}
%    \begin{macrocode}
\newcommand*\AtBeginOfIncludes{%
  \filehook@append\filehook@include@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfIncludes}
%    \begin{macrocode}
\newcommand*\AtEndOfIncludes{%
  \filehook@prefix\filehook@include@@atend
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AfterIncludes}
%    \begin{macrocode}
\newcommand*\AfterIncludes{%
  \filehook@prefix\filehook@include@@after
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfIncludeFile}
%    \begin{macrocode}
\newcommand*\AtBeginOfIncludeFile[1]{%
  \filehook@addtohook\filehook@append\filehook@include@atbegin@{\filehook@ensuretex{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfIncludeFile}
%    \begin{macrocode}
\newcommand*\AtEndOfIncludeFile[1]{%
  \filehook@addtohook\filehook@prefix\filehook@include@atend@{\filehook@ensuretex{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AfterIncludeFile}
%    \begin{macrocode}
\newcommand*\AfterIncludeFile[1]{%
  \filehook@addtohook\filehook@prefix\filehook@include@after@{\filehook@ensuretex{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfInputs}
%    \begin{macrocode}
\newcommand*\AtBeginOfInputs{%
  \filehook@append\filehook@input@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfInputs}
%    \begin{macrocode}
\newcommand*\AtEndOfInputs{%
  \filehook@prefix\filehook@input@@atend
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfInputFile}
%    \begin{macrocode}
\newcommand*\AtBeginOfInputFile{%
  \filehook@addtohook\filehook@append\filehook@input@atbegin@
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfInputFile}
%    \begin{macrocode}
\newcommand*\AtEndOfInputFile{%
  \filehook@addtohook\filehook@prefix\filehook@input@atend@
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfFiles}
%    \begin{macrocode}
\newcommand*\AtBeginOfFiles{%
  \filehook@append\filehook@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfFiles}
%    \begin{macrocode}
\newcommand*\AtEndOfFiles{%
  \filehook@prefix\filehook@@atend
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfEveryFile}
%    \begin{macrocode}
\newcommand*\AtBeginOfEveryFile{%
  \filehook@append\filehook@every@@atbegin
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfEveryFile}
%    \begin{macrocode}
\newcommand*\AtEndOfEveryFile{%
  \filehook@prefix\filehook@every@@atend
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfFile}
%    \begin{macrocode}
\newcommand*\AtBeginOfFile{%
  \filehook@addtohook\filehook@append\filehook@atbegin@
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfFile}
%    \begin{macrocode}
\newcommand*\AtEndOfFile{%
  \filehook@addtohook\filehook@prefix\filehook@atend@
}
%    \end{macrocode}
% \end{macro}
%
%
%
% \begin{macro}{\AtBeginOfClassFile}
%    \begin{macrocode}
\newcommand*\AtBeginOfClassFile{%
    \@ifnextchar*
        {\AtBeginOfXFile@star\@clsextension}%
        {\AtBeginOfXFile@normal\@clsextension}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfPackageFile}
%    \begin{macrocode}
\newcommand*\AtBeginOfPackageFile{%
    \@ifnextchar*
        {\AtBeginOfXFile@star\@pkgextension}%
        {\AtBeginOfXFile@normal\@pkgextension}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfXFile@star}[2]{extension}{name}
% If the class or package is already loaded the code is executed right away.
% Otherwise it is installed normally.
%    \begin{macrocode}
\def\AtBeginOfXFile@star#1*#2{%
    \@ifl@aded{#1}{#2}%
        {\@firstofone}%
        {\AtBeginOfXFile@normal{#1}{#2}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtBeginOfXFile@normal}[2]{extension}{name}
%    \begin{macrocode}
\def\AtBeginOfXFile@normal#1#2{%
    \AtBeginOfFile{#2.#1}%
}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\AtEndOfClassFile}
%    \begin{macrocode}
\newcommand*\AtEndOfClassFile{%
    \@ifnextchar*
        {\AtEndOfXFile@star\@clsextension}%
        {\AtEndOfXFile@normal\@clsextension}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfPackageFile}
%    \begin{macrocode}
\newcommand*\AtEndOfPackageFile{%
    \@ifnextchar*
        {\AtEndOfXFile@star\@pkgextension}%
        {\AtEndOfXFile@normal\@pkgextension}%
}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\AtEndOfXFile@star}[2]{extension}{name}
% If the class or package is already loaded the code is executed right away.
% Otherwise it is installed normally.
%    \begin{macrocode}
\def\AtEndOfXFile@star#1*#2{%
    \@ifl@aded{#1}{#2}%
        {\@firstofone}%
        {\AtEndOfXFile@normal{#1}{#2}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\AtEndOfXFile@normal}[2]{extension}{name}
% Note that \Macro\AtEndOfClass is identical to \Macro\AtEndOfPackage, so no
% differenciation between classes and packages is needed here.
%    \begin{macrocode}
\def\AtEndOfXFile@normal#1#2#3{%
    \AtEndOfFile{#2.#1}{\AtEndOfPackage{#3}}%
}
%    \end{macrocode}
% \end{macro}
%
%
%
%
% \subsection{Installation of Hooks}
% The \Macro\@input@ and \Macro\@iinput macros from |latex.ltx| are redefined to install the hooks.
%
% First the original definitions are saved away.
% \begin{macro}{\filehook@orig@@input@}
%    \begin{macrocode}
\let\filehook@orig@@input@\@input@
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@orig@@iinput}
%    \begin{macrocode}
\let\filehook@orig@@iinput\@iinput
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@input@}
% This macro is redefined for the \Macro\include file hooks.
% Checks if the next command is \Macro\clearpage which indicates that we are inside \Macro\@include.
% If so the hooks are installed, otherwise the original macro is used unchanged.
% For the `after' hook an own \Macro\clearpage is inserted and the original one is gobbled.
%
%    \begin{macrocode}
\def\@input@#1{%
  \@ifnextchar\clearpage
    {%
     \filehook@every@atbegin{#1}%
     \filehook@include@atbegin{#1}%
     \filehook@orig@@input@{#1}%
     \filehook@include@atend{#1}%
     \clearpage
     \filehook@include@after{#1}%
     \filehook@every@atend{#1}%
     \@gobble
    }%
    {\filehook@orig@@input@{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\@iinput}
% This macro is redefined for the \Macro\input file hooks.
% it simply surrounds the original macro with the hooks.
%    \begin{macrocode}
\def\filehook@@iinput#1{%
  \filehook@every@atbegin{#1}%
  \filehook@input@atbegin{#1}%
  \filehook@orig@@iinput{#1}%
  \filehook@input@atend{#1}%
  \filehook@every@atend{#1}%
}
\let\@iinput\filehook@@iinput
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@swap}
% Auxiliary macro which swaps the two arguments. This is needed to expand
% \Macro\@filef@und, which is given as first argument but needed then as the second one.
%    \begin{macrocode}
\def\filehook@swap#1#2{#2#1}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@ensureext}
% This macro ensures the existence of a file name extension. If non is given `|.tex|' is
% added.
%    \begin{macrocode}
\def\filehook@ensureext#1{%
    \expandafter\filehook@@ensureext#1\empty.tex\empty\empty
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@ensureext}
%    \begin{macrocode}
\def\filehook@@ensureext#1.#2\empty#3\empty{#1.#2}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\filehook@ensuretex}
% Ensures a `|.tex|' extension, i.e. adds it if missing, even if there is a different one.
%    \begin{macrocode}
\def\filehook@ensuretex#1{%
    \expandafter\filehook@@ensuretex#1\empty.tex\empty\empty
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@ensuretex}
%    \begin{macrocode}
\def\filehook@@ensuretex#1.tex\empty#2\empty{#1.tex}
%    \end{macrocode}
% \end{macro}
%
%
% The |filehook| default definition of \Macro\InputIfFileExists is defined here
% together with alternatives definitions for comparison.
% There are stored first in a token register and later stored in a macro which is expanded if required.
% This is always done inside a group to keep them temporary only.
% The token register is used to avoid doubling of macro argument characters.
%
% \begin{macro}{\latex@InputIfFileExists}
% Standard \LaTeX\ definition of \Macro\InputIfFileExists.
%    \begin{macrocode}
\long\def\latex@InputIfFileExists#1#2{%
  \IfFileExists{#1}%
    {#2\@addtofilelist{#1}%
     \@@input\@filef@und
    }%
}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\filehook@default@InputIfFileExists}
%    \begin{macrocode}
\long\gdef\filehook@default@InputIfFileExists#1#2{%
  \IfFileExists{#1}%
    {\expandafter\filehook@swap
     \expandafter{\@filef@und}%
     {#2\@addtofilelist{#1}%
     \filehook@every@atbegin{#1}%
     \filehook@atbegin{#1}%
     \@@input}%
     \filehook@atend{#1}%
     \filehook@every@atend{#1}%
    }%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@default@InputIfFileExists}
%    \begin{macrocode}
\long\gdef\filehook@@default@InputIfFileExists#1#2{%
  \let\InputIfFileExists\filehook@InputIfFileExists
  \IfFileExists{#1}%
    {\expandafter\filehook@swap
     \expandafter{\@filef@und}%
     {#2\@addtofilelist{#1}%
     \filehook@atbegin{#1}%
     \@@input}%
     \filehook@atend{#1}%
    }%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\scrlfile@InputIfFileExists}
%    \begin{macrocode}
\long\def\scrlfile@InputIfFileExists#1#2{%
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname #1-@alias\endcsname\relax
    \expandafter\@secondoftwo
  \else
    \scr@replacefile@msg{\csname #1-@alias\endcsname}{#1}%
    \expandafter\@firstoftwo
  \fi
  {%
    \expandafter\InputIfFileExists\expandafter{\csname
      #1-@alias\endcsname}{#2}%
  }%
  {\IfFileExists{#1}{%
      \scr@load@hook{before}{#1}%
      #2\@addtofilelist{#1}%
      \@@input \@filef@und
      \scr@load@hook{after}{#1}%
    }}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@scrlfile@InputIfFileExists}
%    \begin{macrocode}
\long\def\filehook@scrlfile@InputIfFileExists#1#2{%
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname #1-@alias\endcsname\relax
    \expandafter\@secondoftwo
  \else
    \scr@replacefile@msg{\csname #1-@alias\endcsname}{#1}%
    \expandafter\@firstoftwo
  \fi
  {%
    \expandafter\InputIfFileExists\expandafter{\csname
      #1-@alias\endcsname}{#2}%
  }%
  {\IfFileExists{#1}{%
      \expandafter\filehook@swap
      \expandafter{\@filef@und}%
      {\scr@load@hook{before}{#1}%
      #2\@addtofilelist{#1}%
      \filehook@every@atbegin{#1}%
      \filehook@atbegin{#1}%
      \@@input}%
      \filehook@atend{#1}%
      \filehook@every@atend{#1}%
      \scr@load@hook{after}{#1}%
    }}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@scrlfile@InputIfFileExists}
%    \begin{macrocode}
\long\def\filehook@@scrlfile@InputIfFileExists#1#2{%
  \let\InputIfFileExists\filehook@InputIfFileExists
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname #1-@alias\endcsname\relax
    \expandafter\@secondoftwo
  \else
    \scr@replacefile@msg{\csname #1-@alias\endcsname}{#1}%
    \expandafter\@firstoftwo
  \fi
  {%
    \expandafter\InputIfFileExists\expandafter{\csname
      #1-@alias\endcsname}{#2}%
  }%
  {\IfFileExists{#1}{%
      \expandafter\filehook@swap
      \expandafter{\@filef@und}%
      {\scr@load@hook{before}{#1}%
      #2\@addtofilelist{#1}%
      \filehook@atbegin{#1}%
      \@@input}%
      \filehook@atend{#1}%
      \scr@load@hook{after}{#1}%
    }}%
}
%    \end{macrocode}
% \end{macro}
%
% \iffalse
%</package>
%<*memoir>
% \fi
%
%    \begin{macrocode}
\ProvidesPackage{filehook-memoir}[2011/01/03 v0.1 filehook patch for memoir class]
\RequirePackage{filehook}
\begingroup
%    \end{macrocode}
%
% \begin{macro}{\memoir@InputIfFileExists}
%    \begin{macrocode}
\long\def\memoir@InputIfFileExists#1#2{%
  \IfFileExists{#1}%
    {#2\@addtofilelist{#1}\m@matbeginf{#1}%
     \@@input \@filef@und
     \m@matendf{#1}%
     \killm@matf{#1}}%
}
%    \end{macrocode}
% \end{macro}
%
%    \begin{macrocode}
\ifcase
    \ifx\InputIfFileExists\latex@InputIfFileExists 0\else
    \ifx\InputIfFileExists\memoir@InputIfFileExists 0\else
     1%
    \fi\fi
\relax
  \global\let\filehook@InputIfFileExists\filehook@default@InputIfFileExists
  \global\let\filehook@@InputIfFileExists\filehook@@default@InputIfFileExists
  \global\let\InputIfFileExists\filehook@InputIfFileExists
  \filehook@appendwarg\filehook@atbegin{\m@matbeginf{#1}}%
  \filehook@prefixwarg\filehook@atend{\m@matendf{#1}\killm@matf{#1}}%
  \PackageInfo{filehook}{Detected 'memoir' class: the memoir hooks will be moved to the `At...OfFiles' hooks}
\else
  \iffilehook@force
    \global\let\filehook@InputIfFileExists\filehook@default@InputIfFileExists
    \global\let\filehook@@InputIfFileExists\filehook@@default@InputIfFileExists
    \global\let\InputIfFileExists\filehook@InputIfFileExists
    \PackageWarning{filehook}{Detected 'memoir' class with unknown definition of \string\InputIfFileExists.^^J%
                              The 'force' option of 'filehook' is in effect. Macro is overwritten with default!}%
  \else
    \PackageError{filehook}{Detected 'memoir' class with unknown definition of \string\InputIfFileExists.^^J%
                            Use the 'force' option of 'filehook' to overwrite it.}{}%
  \fi
\fi
%    \end{macrocode}
%
%    \begin{macrocode}
\endgroup
%    \end{macrocode}
%
% \iffalse
%</memoir>
%<*listings>
% \fi
%    \begin{macrocode}
\ProvidesPackage{filehook-listings}[2011/01/02 v0.1 Patch for listings to avoid hooks for verbatim input files]
\begingroup

\long\def\patch#1\def\lst@next#2#3\endpatch{%
    \toks@{#2}%
    \edef\@tempa{\the\toks@}%
    \def\@tempb{\input{####1}}%
    \ifx\@tempa\@tempb
        \gdef\lst@InputListing##1{#1\def\lst@next{\@input{##1}}#3}%
    \else
        \PackageWarning{filehook-listings}{To-be-patched code in macro \string\lst@InputListing was not found!}%
    \fi
}

\@ifundefined{lst@InputListing}{%
    \PackageWarning{filehook-listings}{To-be-patched Macro \string\lst@InputListing not found!}%
}{}

\expandafter\patch\lst@InputListing{#1}\endpatch

\endgroup
%    \end{macrocode}
%
% \iffalse
%</listings>
%<*scrlfile>
% \fi
%
%    \begin{macrocode}
\ProvidesPackage{filehook-scrlfile}[2011/01/03 v0.1 filehook patch for scrlfile package]
\RequirePackage{filehook}
\begingroup
%    \end{macrocode}
%
% \begin{macro}{\scrlfile@InputIfFileExists}
%    \begin{macrocode}
\long\def\scrlfile@InputIfFileExists#1#2{%
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname #1-@alias\endcsname\relax
    \expandafter\@secondoftwo
  \else
    \scr@replacefile@msg{\csname #1-@alias\endcsname}{#1}%
    \expandafter\@firstoftwo
  \fi
  {%
    \expandafter\InputIfFileExists\expandafter{\csname
      #1-@alias\endcsname}{#2}%
  }%
  {\IfFileExists{#1}{%
      \scr@load@hook{before}{#1}%
      #2\@addtofilelist{#1}%
      \@@input \@filef@und
      \scr@load@hook{after}{#1}%
    }}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@scrlfile@InputIfFileExists}
%    \begin{macrocode}
\long\def\filehook@scrlfile@InputIfFileExists#1#2{%
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname #1-@alias\endcsname\relax
    \expandafter\@secondoftwo
  \else
    \scr@replacefile@msg{\csname #1-@alias\endcsname}{#1}%
    \expandafter\@firstoftwo
  \fi
  {%
    \expandafter\InputIfFileExists\expandafter{\csname
      #1-@alias\endcsname}{#2}%
  }%
  {\IfFileExists{#1}{%
      \expandafter\filehook@swap
      \expandafter{\@filef@und}%
      {\scr@load@hook{before}{#1}%
      #2\@addtofilelist{#1}%
      \filehook@every@atbegin{#1}%
      \filehook@atbegin{#1}%
      \@@input}%
      \filehook@atend{#1}%
      \filehook@every@atend{#1}%
      \scr@load@hook{after}{#1}%
    }}%
}
%    \end{macrocode}
% \end{macro}
%
% \begin{macro}{\filehook@@scrlfile@InputIfFileExists}
%    \begin{macrocode}
\long\def\filehook@@scrlfile@InputIfFileExists#1#2{%
  \let\InputIfFileExists\filehook@InputIfFileExists
  \begingroup\expandafter\expandafter\expandafter\endgroup
  \expandafter\ifx\csname #1-@alias\endcsname\relax
    \expandafter\@secondoftwo
  \else
    \scr@replacefile@msg{\csname #1-@alias\endcsname}{#1}%
    \expandafter\@firstoftwo
  \fi
  {%
    \expandafter\InputIfFileExists\expandafter{\csname
      #1-@alias\endcsname}{#2}%
  }%
  {\IfFileExists{#1}{%
      \expandafter\filehook@swap
      \expandafter{\@filef@und}%
      {\scr@load@hook{before}{#1}%
      #2\@addtofilelist{#1}%
      \filehook@atbegin{#1}%
      \@@input}%
      \filehook@atend{#1}%
      \scr@load@hook{after}{#1}%
    }}%
}
%    \end{macrocode}
% \end{macro}
%
% If the |scrlfile| package definition is detected the |filehook|s are added
% to that definition. Unfortunately the \Macro\scr@load@hook{before} hook is placed \emph{before}
% not after the |#2\@addtofilelist{#1}| code. Otherwise the |filehook|s could simply be added to these hooks.
% Note that this will stop working if |scrlfile| ever changes its definition of the \Macro\InputIfFileExists macro.
%    \begin{macrocode}
\ifcase
    \ifx\InputIfFileExists\latex@InputIfFileExists 0\else
    \ifx\InputIfFileExists\scrlfile@InputIfFileExists 0\else
     1%
    \fi\fi
\relax
  \global\let\filehook@InputIfFileExists\filehook@scrlfile@InputIfFileExists
  \global\let\filehook@@InputIfFileExists\filehook@@scrlfile@InputIfFileExists
  \global\let\InputIfFileExists\filehook@InputIfFileExists
  \PackageInfo{filehook}{Package 'scrlfile' detected and compensated for}%
\else
  \iffilehook@force
    \global\let\filehook@InputIfFileExists\filehook@default@InputIfFileExists
    \global\let\filehook@@InputIfFileExists\filehook@@default@InputIfFileExists
    \global\let\InputIfFileExists\filehook@InputIfFileExists
    \PackageWarning{filehook}{Detected 'scrlfile' package with unknown definition of \string\InputIfFileExists.^^J%
                              The 'force' option of 'filehook' is in effect. Macro is overwritten with default!}%
  \else
    \PackageError{filehook}{Detected 'scrlfile' package with unknown definition of \string\InputIfFileExists.^^J%
                            Use the 'force' option of 'filehook' to overwrite it.}{}%
  \fi
\fi
%    \end{macrocode}
%
%    \begin{macrocode}
\endgroup
%    \end{macrocode}
%
%
% \iffalse
%</scrlfile>
%<*fink>
% \fi
%
%    \begin{macrocode}
\ProvidesPackage{filehook-fink}[2011/01/03 v0.1 filehook compatibility code for fink package]
\RequirePackage{filehook}
\RequirePackage{currfile}%

\begingroup

\long\def\fink@old@InputIfFileExists#1#2{%
  \IfFileExists{#1}{%
    #2\@addtofilelist{#1}%
    \fink@prepare{#1}%
    \expandafter\fink@input%
    \expandafter\fink@restore\expandafter{\finkpath}}%
}

\long\def\fink@new@InputIfFileExists#1#2{%
  \IfFileExists{#1}{%
    #2\@addtofilelist{#1}%
    \edef\fink@before{\noexpand\fink@input{#1}}%
    \edef\fink@after{\noexpand\fink@restore{\finkpath}}%
    \expandafter\fink@before\fink@after}%
}

\ifcase
    \ifx\InputIfFileExists\filehook@InputIfFileExists 0\else
    \ifx\InputIfFileExists\latex@InputIfFileExists    1\else
    \ifx\InputIfFileExists\fink@new@InputIfFileExists 1\else
    \ifx\InputIfFileExists\fink@old@InputIfFileExists 1\else
     1%
    \fi\fi\fi\fi
\relax
\or
  \global\let\filehook@InputIfFileExists\filehook@default@InputIfFileExists
  \global\let\filehook@@InputIfFileExists\filehook@@default@InputIfFileExists
  \global\let\InputIfFileExists\filehook@InputIfFileExists
  \PackageInfo{filehook-fink}{Package 'fink' detected and replaced by 'currfile'}%
\else
  \iffilehook@force
    \global\let\filehook@InputIfFileExists\filehook@default@InputIfFileExists
    \global\let\filehook@@InputIfFileExists\filehook@@default@InputIfFileExists
    \global\let\InputIfFileExists\filehook@InputIfFileExists
    \PackageWarning{filehook-fink}{Detected 'fink' package with unknown definition of \string\InputIfFileExists.^^J%
                              The 'force' option of 'filehook' is in effect. Macro is overwritten with default!}%
  \else
    \PackageError{filehook-fink}{Detected 'fink' package with unknown definition of \string\InputIfFileExists.^^J%
                                 Use the 'force' option of 'filehook' to overwrite it.}{}%
  \fi
\fi

\endgroup
%    \end{macrocode}
%
% \iffalse
%</fink>
%<*package>
% \fi
%
%
% \begin{macro}{\InputIfFileExists}
% First we test for the |scrlfile| package. The test macro adds the necessary patches if so.
% In order to also support it when it is loaded afterwards the two hooks below are used to revert the definition
% before the package and patch it afterwards.
%    \begin{macrocode}
\AtBeginOfPackageFile*{scrlfile}{%
   \let\InputIfFileExists\latex@InputIfFileExists
}%
\AtEndOfPackageFile*{scrlfile}{%
   \RequirePackage{filehook-scrlfile}%
}%
%    \end{macrocode}
% Fink:
%    \begin{macrocode}
\AtBeginOfPackageFile*{fink}{%
   \RequirePackage{kvoptions}%
   \begingroup
   \let\InputIfFileExists\latex@InputIfFileExists
}%
\AtEndOfPackageFile*{fink}{%
   \edef\@tempa{\noexpand\PassOptionsToPackage{mainext=\fnk@mainext,maindir=\fnk@maindir}{currfile}}%
   \expandafter\endgroup\@tempa
   \RequirePackage{filehook-fink}%
}%
%    \end{macrocode}
% If |memoir| is detected its hooks
% are added to the appropriate `At...OfFiles' hooks. This works fine because its hooks have the
% exact same position. Please note that the case when |memoir| is used together with |scrlfile| is not explicitly covered.
% In this case the |scrlfile| package will overwrite |memoir|s definition.
%    \begin{macrocode}
\AtBeginOfClassFile*{memoir}{%
  \let\filehook@@InputIfFileExists\latex@InputIfFileExists
  \let\InputIfFileExists\latex@InputIfFileExists
  \let\@iinput\filehook@orig@@iinput
}%
\AtEndOfClassFile*{memoir}{%
  \let\@iinput\filehook@@iinput
  \RequirePackage{filehook-memoir}%
}%
%    \end{macrocode}
% Finally, if no specific alternate definition is detected the original \LaTeX\ definition is checked for and a
% error is given if any other unknown definition is detected.
% The \opt{force} option will change the error into a warning and overwrite the macro with the default.
%    \begin{macrocode}
\ifcase
    \ifx\InputIfFileExists\filehook@InputIfFileExists 0\else
    \ifx\InputIfFileExists\latex@InputIfFileExists 1\else
    \iffilehook@force 1\else
    9%
    \fi\fi\fi
\relax% 0
\or% 1
    \let\filehook@InputIfFileExists\filehook@default@InputIfFileExists
    \let\filehook@@InputIfFileExists\filehook@@default@InputIfFileExists
    \let\InputIfFileExists\filehook@InputIfFileExists
    \iffilehook@force
      \PackageWarning{filehook}{Detected unknown definition of \string\InputIfFileExists.^^J%
                                The 'force' option of 'filehook' is in effect. Macro is overwritten with default!}%
    \fi
\else
    \PackageError{filehook}{Detected unknown definition of \string\InputIfFileExists.^^J%
                            Use the 'force' option of 'filehook' to overwrite it.}{}%
\fi
%    \end{macrocode}
% \end{macro}
%
%    \begin{macrocode}
\AtBeginDocument{%
    \ifx\InputIfFileExists\filehook@InputIfFileExists\else
        \PackageWarning{filehook}{Macro \string\InputIfFileExists\space got redefined after 'filehook' was loaded.^^J%
                                  Certain file hooks might now be dysfunctional!}
    \fi
}
%    \end{macrocode}
%
% \iffalse
%</package>
% \fi
% \Finale
\endinput