考虑以下包的代码:
% Preamble
\NeedsTeXFormat{LaTeX2e}[1994/06/01]
\ProvidesPackage{mypackage}[2024/01/01 MyPackage]
\makeatletter
% Dependencies
\RequirePackage{pgfopts}
\RequirePackage{xparse}
\RequirePackage{xcolor}
% Package options
\pgfkeys{
/mypackage/.cd,
firstcolor/.store in = \mypackage@firstcolor,
firstcolor = blue,
secondcolor/.store in = \mypackage@secondcolor,
secondcolor = red,
}
\ProcessPgfPackageOptions{/mypackage}
% Definition of `\setcolors` here
% Definition of `\resetcolors` here
% Definition of `\printcolors` here
% Definition of `\newcolortheme` here
% End
\makeatother
我想定义以下三个函数,它们具有以下行为:
\setcolors
:更改firstcolor
并secondcolor
调用文档其余部分\resetcolors
:忘记 setcolors 所做的所有更改,恢复为包的原始选项\printcolors
:默认情况下使用当前全局firstcolor
和secondcolor
,但有一个可选参数可以用本地值覆盖全局值\newcolortheme
:提供创建颜色主题的可能性,以便为一对firstcolor
和赋予特殊名称secondcolor
从用户端来看,情况如下:
\documentclass[12pt]{article}
\usepackage[firstcolor = green, secondcolor = yellow]{mypackage}
\newcolortheme{mytheme}{firstcolor = brown, secondcolor = cyan}
\begin{document}
\printcolors % Will print green and yellow
\printcolors[secondcolor = blue] % Will print green and blue
\printcolors % Will print green and yellow
\setcolors{secondcolor = black}
\printcolors % Will print green and black
\printcolors[firstcolor = purple] % Will print purple and black
\printcolors % Will print green and black
\setcolors{firstcolor = red}
\printcolors % Will print red and black
\setcolors{firstcolor = orange, secondcolor = pink}
\printcolors % Will print orange and pink
\resetcolors
\printcolors % Will print green and yellow
\printcolors[mytheme] % Will print brown and cyan
\printcolors % Will print green and yellow
\setcolors{mytheme}
\printcolors % Will print brown and cyan
\end{document}
我不知道该如何实现这一点。
问题 :如何定义\setcolors
、、\resetcolors
并实现这一点\printcolors
?\newcolortheme
答案1
这是一个可能的方法:
\begin{filecontents*}[overwrite]{mypackage.sty}
% Preamble
\NeedsTeXFormat{LaTeX2e}[1994/06/01]
\ProvidesPackage{mypackage}[2024/01/01 MyPackage]
% Dependencies
\RequirePackage{pgfopts}
\RequirePackage{xparse}
\RequirePackage{xcolor}
\pgfkeys{/mypackage/.is family}
\def\mypackage@set#1{\pgfkeys{/mypackage,#1}}
\mypackage@set{
% storage
first-color/.store in=\mypackage@firstcolor,
second-color/.store in=\mypackage@secondcolor,
% default value
first-color=blue,
second-color=red,
mypackage@init/.style/.expanded={
first-color=\mypackage@firstcolor,
second-color=\mypackage@secondcolor
}
}
\ProcessPgfPackageOptions{/mypackage}
\mypackage@set{
mypackage@init/.style/.expanded={
first-color=\mypackage@firstcolor,
second-color=\mypackage@secondcolor
}
}
\NewDocumentCommand\newcolortheme{mm}{\mypackage@set{#1/.style={#2}}}
\NewDocumentCommand\printcolors{O{}}{%
\bgroup%
\mypackage@set{#1}%
\mypackage@firstcolor{} and \mypackage@secondcolor{}\par%
\egroup
}
\NewDocumentCommand\setcolors{m}{\mypackage@set{#1}}
\NewDocumentCommand\resetcolors{}{\mypackage@set{mypackage@init}}
\end{filecontents*}
\documentclass[preview=true,varwidth=true]{standalone}
\usepackage[first-color=green, second-color=yellow]{mypackage}
\newcolortheme{my theme}{first-color=brown, second-color=cyan}
% \setcolors{my theme/.style={first-color=brown, second-color=cyan}}
\begin{document}
\printcolors % Will print green and yellow
\printcolors[second-color=blue] % Will print green and blue
\printcolors % Will print green and yellow
\setcolors{second-color=black}
\printcolors % Will print green and black
\printcolors[first-color=purple] % Will print purple and black
\printcolors % Will print green and black
\setcolors{first-color=red}
\printcolors % Will print red and black
\setcolors{first-color=orange, second-color=pink}
\printcolors % Will print orange and pink
\resetcolors
\printcolors % Will print green and yellow
\printcolors[my theme] % Will print brown and cyan
\printcolors % Will print green and yellow
\setcolors{my theme}
\printcolors % Will print brown and cyan
\end{document}
(注意:该\setcolor
宏就像的别名\mypackage@set
)
结果
答案2
下面展示了两种无需\printcolors
分组(可能是也可能不是更好的选择)就能实现这一目标的方法。
这两个代码都使用了该expkv
系列的软件包(免责声明:我是作者)。第一个expkv-cs
在其核心中使用,这使得编写不需要组的代码变得相当简单(因为 key=value 处理程序不需要任何赋值,因此\printcolors
宏纯粹通过扩展而不是赋值来工作——如果从此断言中免除对可选参数的解析)。第二个只是在每次调用时重置默认值(以相当高效的方式),并且\setcolors
只更改用于设置回默认值的宏。
\begin{filecontents}{\jobname.sty}
\ProvidesPackage{\@currname}[2024-01-24 adhoc test package]
\RequirePackage{expkv-cs,expkv-opt,expkv-def}
% define keys as used for the package (we don't need the keys defined here
% otherwise)
\ekvdefinekeys{\@currname}
{
store firstcolor = \my@firstcolor
,initial firstcolor = blue
,store secondcolor = \my@secondcolor
,initial secondcolor = red
}
\ekvoProcessLocalOptions{\@currname}
% parsing for an optional argument
\newcommand\printcolors[1][]{\@printcolors{#1}}
% assign default values ('o: ' means expand value once)
\ekvcSplit\@printcolors
{
o: firstcolor = \my@firstcolor
,o: secondcolor = \my@secondcolor
}
{#1 and #2\par}
% just change the default values of the underlying ekvc-macro
\protected\def\setcolors{\ekvcChange\@printcolors}
% store the current values (package defaults), using \edef for expansion
\protected\edef\resetcolors
{%
\setcolors
{%
% control the expansion to only do a single step (most likely
% unnecessary but we never know with arbitrary user input)
firstcolor = {\unexpanded\expandafter{\my@firstcolor}}
,secondcolor = {\unexpanded\expandafter{\my@secondcolor}}
}%
}
% just define '#1' to be considered additional key=value input '#2' using
% ekvcSecondaryKeys.
\protected\def\newcolortheme#1#2%
{\ekvcSecondaryKeys\@printcolors{nmeta #1 = {#2}}}
\end{filecontents}
\begin{filecontents}{\jobname2.sty}
\ProvidesPackage{\@currname}[2024-01-24 adhoc test package]
\RequirePackage{expkv-opt,expkv-def}
\ekvdefinekeys{my}
{
store firstcolor = \my@firstcolor
,initial firstcolor = blue
,store secondcolor = \my@secondcolor
,initial secondcolor = red
}
\ekvsetdef\@setcolors@keys{my}
\ekvoProcessLocalOptions{my}
% common code used to save the current values of all keys that should be
% persistent.
% 'o: ' means expand the value once before passing it to the key's code.
\newcommand*\my@storecolours@keys
{%
o: firstcolor = \my@firstcolor
,o: secondcolor = \my@secondcolor
}
% \@resetcolors is used to store the package default values
% 'R: ' means expand the following macro once and use it as key=value input
\protected\ekvcompile\@resetcolors{my}{R: \my@storecolours@keys}
% \@setcolors is used to restore the currently valid colours on each call
\protected\def\resetcolors{\let\@setcolors\@resetcolors}
\resetcolors
\protected\def\setcolors#1%
{%
% bit of juggling to get the normal key=value parser, but also build a fast
% list of finalised colours
\begingroup
\ekvset{my}{#1}%
\ekvcompile\@setcolors{my}{R: \my@storecolours@keys}%
% expansion trick to store the meaning of \@setcolors as valid inside this
% group outside the group, without needing any global assignments
\expanded{\endgroup
\protected\edef\noexpand\@setcolors
{\noexpand\unexpanded{\unexpanded\expandafter{\@setcolors}}}%
}%
}
% just treat the key '#1' as additional key=value input containing '#2' (rather
% straight forward)
\protected\def\newcolortheme#1#2{\ekvdefNoVal{my}{#1}{\ekvmorekv{#2}}}
\newcommand\printcolors[1][]
{%
% restore current default values
\@setcolors
% maybe set different values
\@setcolors@keys{#1}%
% use values
\my@firstcolor\space and \my@secondcolor
\par
}
\end{filecontents}
\documentclass[12pt]{article}
\usepackage[firstcolor = green, secondcolor = yellow]{\jobname} % both work
% \usepackage[firstcolor = green, secondcolor = yellow]{\jobname2} % both work
\newcolortheme{mytheme}{firstcolor = brown, secondcolor = cyan}
\begin{document}
\printcolors % Will print green and yellow
\printcolors[secondcolor = blue] % Will print green and blue
\printcolors % Will print green and yellow
\bigskip
\setcolors{secondcolor = black}
\printcolors % Will print green and black
\printcolors[firstcolor = purple] % Will print purple and black
\printcolors % Will print green and black
\bigskip
\setcolors{firstcolor = red}
\printcolors % Will print red and black
\bigskip
\setcolors{firstcolor = orange, secondcolor = pink}
\printcolors % Will print orange and pink
\bigskip
\resetcolors
\printcolors % Will print green and yellow
\printcolors[mytheme] % Will print brown and cyan
\printcolors % Will print green and yellow
\bigskip
\setcolors{mytheme}
\printcolors % Will print brown and cyan
\end{document}
无论你\usepackage{\jobname}
还是\usepackage{\jobname2}
结果是否看起来像这样: