Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix '.search also' with /handler config=full or existing #1144

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix '.search also' with /handler config=full or existing #1144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
61be7cd
Fix '.search also' with /handler config=full or existing
fritzw Mar 9, 2022
f857fc8
docs: improve /handler config docs
fritzw Mar 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/generic/pgf/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ lot of contributed changes. Thanks to everyone who volunteered their time!
case the value is undefined instead of a `\relax`ed csname. It has always been
semantically wrong to assign to the result of `\pgfkeysgetvalueof`, but now it
will have undesired side-effects. Therefore this change is breaking.
- If `/handler config=full or existing` is active, `/.style={...}` assignments
can now fail if the style is not found in any `.search also` path. Previously,
the style was always set in the first search path, if it was not found in the
currently active path.

### Added

Expand Down Expand Up @@ -74,6 +78,7 @@ lot of contributed changes. Thanks to everyone who volunteered their time!
- Form-only patterns have no specified color #1122
- Make `graphdrawing` work with `name prefix` and `name suffix` options #1087
- pgfkeys was a bit too relaxed around `\relax` #1132
- Fix `.search also` when `/handler config=full or existing` is active #1143

### Changed

Expand All @@ -90,6 +95,7 @@ lot of contributed changes. Thanks to everyone who volunteered their time!

- 3geek14
- BeneIII
- Fritz Webering
- graue70
- Gábor Braun
- Joel Coffman
Expand Down
34 changes: 28 additions & 6 deletions doc/generic/pgf/pgfmanual-en-pgfkeys.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,8 +810,9 @@ \subsubsection{Keys That Are Handled}
\begin{key}{/handler config/only existing/add exception=\marg{key handler name}}
Allows to add exceptions to the |/handler config=only existing| feature.
Initially exceptions for the key handlers |/.cd|, |/.try|, |/.retry|,
|/.lastretry| and |/.unknown| are defined. The value \marg{key handler
name} should be the name of a key handler.
|/.lastretry|, |/.unknown|, |/.expand once|, |/.expand twice| and
|/.expanded| are defined. The value \marg{key handler name} should be
the name of a key handler.
\end{key}


Expand Down Expand Up @@ -1249,7 +1250,7 @@ \subsubsection{Defining Value-, Macro-, If- and Choice-Keys}
and, thus, |\pgfkeysnovalue| will be stored in |/my key|.

To retrieve the value stored in a key, the handler |/.get| is used.

\medskip
\emph{Remark:} A key can both store a value and execute commands%
\footnote{This behavior was partially changed in \pgfname{} 3.1.6 and then
Expand Down Expand Up @@ -1623,10 +1624,31 @@ \subsubsection{Handlers for Forwarding}
|/handler config=full or existing| when you use |/.search also|, that is,
use
%
\begin{codeexample}[code only]
\begin{codeexample}[]
\pgfkeys{
/main path/.search also={/second path, /third path},
/handlers/.unknown/.code={Unknown key `\pgfkeyscurrentkey'},
/handler config=full or existing,
% This works, because these are a full keys:
/second path/key/.code={Original value},
/third path/other key/.code={Other value},
}

\pgfkeys{
/main path/.search also={/secondary path},
/handler config=full or existing}
/main path/.cd,
% This works, because the keys are found in '.search also'.
key/.code={value1},
other key/.code={value2},
}
\texttt{key} = \pgfkeys{/second path/key},
\texttt{other key} = \pgfkeys{/third path/other key},

\pgfkeys{
/main path/.cd,
% The '.code' handler is not executed because 'undefined key'
% does not exist in either of the '.search also' paths.
undefined key/.code={New value},
}
\end{codeexample}
%
\end{handler}
Expand Down
8 changes: 7 additions & 1 deletion tex/generic/pgf/utilities/pgfkeys.code.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1006,7 +1006,13 @@
\pgfkeys{/handlers/.expand twice/.code=\expandafter\expandafter\expandafter\pgfkeys@exp@call\expandafter\expandafter\expandafter{#1}}
\pgfkeys{/handlers/.expanded/.code=\edef\pgfkeys@temp{#1}\expandafter\pgfkeys@exp@call\expandafter{\pgfkeys@temp}}

\long\def\pgfkeys@exp@call#1{\pgfkeysalso{\pgfkeyscurrentpath={#1}}}
\long\def\pgfkeys@exp@call#1{%
\ifpgfkeysaddeddefaultpath% If the original key was a relative path, do the expanded assignment also with a relative path
\pgfkeys@pathtoks{}%
\expandafter\pgfkeys@splitter\pgfkeyscurrentkeyRAW//% Removes the /.expand* component of the original relative key.
\fi
\pgfkeysalso{\pgfkeyscurrentpath={#1}}%
}

\def\pgfkeys@mathparse{%
\pgfkeys@ifcsname{pgfmathparse}{%
Expand Down