summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/urcls/tex/URspecialopts.sty
blob: 4e47366cd294bddae122ff11dc0d3e14cca40a7a (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
%% 
%%  This is file `URspecialopts.sty' version 2.1 (2019/01/22),
%%	it is part of
%%  urcls -- Corporate Design for the University of Regensburg
%% ----------------------------------------------------------------------------
%%
%%  Copyright (C) 2016--2019 by Marei Peischl <TeX@mareipeischl.de>
%%
%% ----------------------------------------------------------------------------
%%  License information
%% ----------------------------------------------------------------------------
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% 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.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This work has the LPPL maintenance status `maintained'.
%%
%% The Current Maintainer of this work is Marei Peischl.
%%
%% ============================================================================
%%
%%  Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz
%%  in der Version 1.3c, verteilt und/oder verändert werden. Die aktuelle
%%  Version dieser Lizenz ist http://www.latex-project.org/lppl.txt und
%%  Version 1.3c oder neuer ist Teil aller LaTeX-Distributionen ab 2005/12/01. 
%%  Dieses Werk hat den LPPL-Verwaltungs-Status "maintained". 
%%  Die Verwaltung liegt aktuell bei der Autorin, Marei Peischl.
%%
%% ----------------------------------------------------------------------------
%%  End of license information
%% ----------------------------------------------------------------------------
%%

\NeedsTeXFormat{LaTeX2e}
\def\fileversion{2.1}
\def\filedate{2019/01/22}

\RequirePackage{expl3}
\ProvidesExplPackage{URspecialopts}{\filedate}{\fileversion}{Implementation of keyval-options accepting multiple values as grouped clists}

\RequirePackage{l3keys2e}
\RequirePackage{xparse}

%defining Keys for specialopts own Options:
\keys_define:nn { specialopts.sty }
{
	%enabling passkeyprocessing (initially true)
	passkey .bool_set:N = \l_specialopts@PassKey_bool,
	passkey .default:n = true,
	passkey .initial:n = true,

	special .bool_set:N = \l_specialopts@Special_bool,
	special .default:n = true,
	special .initial:n = true
}


\ProcessKeysPackageOptions{ specialopts.sty }

\NewDocumentCommand\Define@specialopt@Module{O{\@currname.\@currext}}{
	\bool_if:NT \l_specialopts@Special_bool {\clist_new:c {l_#1@SpecialKey_clist}}
	\bool_if:NT \l_specialopts@PassKey_bool {\clist_new:c {l_#1@PassKey_clist}}
}

\NewDocumentCommand\Module@DefineSpecialPassKey{O{\@currname.\@currext}md<>}{
	\clist_put_right:cx {l_#1@PassKey_clist} {#2}
	\tl_new:c {l_#1@#2@values_tl}
	\IfNoValueF{#3}{\tl_new:c {l_#1@#2@package_tl} \tl_set:cn {l_#1@#2@package_tl} {#3}}
}

\cs_new:Nn \specialopt_Parse@OptionValue:n {\tl_if_empty:nF {#1} {=#1}}

\NewDocumentCommand\Module@DeclarePassOption{sO{\@currname.\@currext}mO{}m}{
	\exp_args:Nx	\keys_define:nn {#2} {
		#3 .code:n = {\IfBooleanTF{#1}
			{\PassOptionsToClass{#3\specialopt_Parse@OptionValue:n {##1}}{#5}}
			{\PassOptionsToPackage{#3\specialopt_Parse@OptionValue:n {##1}}{#5}}
		},
	}
}

% Define a SpecialKey (#2) using code (#3) 
% the code inside #3 can use one Argument   (#1) 
% the Argument will be the token list containing the values
\NewDocumentCommand\Module@DefineSpecialKey{O{\@currname.\@currext}mm}{
	\clist_put_right:cx {l_#1@SpecialKey_clist} {#2}
	\tl_new:c {l_#1@#2@values_tl}
	\cs_new:cpn {SpecialKey_#1@#2_code:c} ##1 {#3} 
}


%[Module]{clist-item: Names to Filter}{clist-item: unprocessed Options}
% remove all specialopts from unprocessed options
\cs_new:Npn \Module@Options@Filter:xcc [#1]#2#3 {
%	\clist_show:c {#2}
%	\clist_show:c {#3}
	\clist_set_eq:Nc \l_specialopts_Compare@Key_clist {#2}
	\clist_clear:N \l_specialopts_unprocessed@Key_clist
	\tl_set:Nx \l_specialopts_CompareModule_tl {#1}
	\exp_args:NNNx \keyval_parse:NNn  \specialopts_Compare@KeyLists:n \specialopts_Compare@KeyLists:nn {\clist_use:cn {#3} {,}}
	\clist_set_eq:cN {#3} \l_specialopts_unprocessed@Key_clist
%	\clist_show:c {#3}
}

\msg_new:nnn {URspecialopts.sty} {no-specialopt-value} {You entered a specialopt or pass key (#1) without any value. \\\\
	Ignoring this key.
}

%Variant for Keys without values
\cs_new:Nn \specialopts_Compare@KeyLists:n {
	\clist_if_in:NnTF \l_specialopts_Compare@Key_clist {#1} 
		{\msg_warning:nnn {URspecialopts.sty} {no-specialopt-value} {#1}}
		{\clist_put_right:Nx \l_specialopts_unprocessed@Key_clist {#1}}
	}

%Variante for Keys with values
\cs_new:Nn \specialopts_Compare@KeyLists:nn {
	\clist_if_in:NnTF \l_specialopts_Compare@Key_clist {#1}
		{\tl_put_right:cx {l_\l_specialopts_CompareModule_tl @#1@values_tl}{#2}}
		{
			\tl_if_in:nnTF {#2} {,}
				{\clist_put_right:Nx \l_specialopts_unprocessed@Key_clist {#1={#2}}}
				{\clist_put_right:Nx \l_specialopts_unprocessed@Key_clist {#1=#2}}
		}
	}


%Create Module@Process@SpecialOptions [module]
\bool_lazy_any:nTF {{\l_specialopts@PassKey_bool} {\l_specialopts@Special_bool}}
{
	\NewDocumentCommand{\Module@Process@SpecialOptions}{O{\@currname.\@currext}}{
		\clist_new:c {l_#1@unprocessed_clist}
		\clist_set:cx {l_#1@unprocessed_clist} {\@ptionlist{\@currname.\@currext}}
		\bool_if:NTF \l_specialopts@PassKey_bool {
			\clist_if_empty:cF {l_#1@PassKey_clist}{
				\Module@Options@Filter:xcc [#1]{l_#1@PassKey_clist}{l_#1@unprocessed_clist}
				\clist_map_inline:cn {l_#1@PassKey_clist} {
					\exp_args:Nc \tl_if_blank:VF {l_#1@##1@values_tl}{
						\PassOptionsToPackage{\tl_use:c {l_#1@##1@values_tl}}{
							\tl_if_exist:cTF {l_#1@##1@package_tl}
								{\tl_use:c {l_#1@##1@package_tl}}
								{##1}
						}
					}
				}
			}
		}
		{\clist_if_empty:cF {l_#1@PassKey_clist}}
	\bool_if:NT \l_specialopts@Special_bool {
		\clist_if_empty:cF {l_#1@SpecialKey_clist}{
			\Module@Options@Filter:xcc [#1]{l_#1@SpecialKey_clist}{l_#1@unprocessed_clist}
			\clist_map_inline:cn {l_#1@SpecialKey_clist} {
				\tl_if_empty:cF {l_#1@##1@values_tl} 
					{\exp_args:Nnc \use:c {SpecialKey_#1@##1_code:c} {l_#1@##1@values_tl}}
			}
		}
	}
	\expandafter\edef\csname opt@\@currname.\@currext\endcsname{\clist_use:cn {l_#1@unprocessed_clist} {,}}%{\tl_use:N \l_tmpb_tl}
	\if_meaning:w\@currext\@clsextension
	\edef\@classoptionslist{\clist_use:cn {l_#1@unprocessed_clist} {,}}
	\fi:	
	}
}{
	\let\Module@Process@SpecialOptions\relax
}
\ExplSyntaxOff

\endinput