path: root/Master/texmf-dist/tex/latex/yquant/yquant-env.tex

\newif\ifyquant@env@lazy

\protected\def\yquant@envunstar{%
   \yquant@env@lazyfalse%
   \yquant@env@begin%
}

\protected\def\yquant@envstar{%
   \yquant@env@lazytrue%
   \yquant@env@begin%
}

\protected\def\yquant@env@begin{%
   % We check for an optional argument, but if it is in a new line, we don't take it - it
   % might well be the square brace of an argument. Temporary change newlines to ordinary
   % characters.
   \catcode`\^^M=12 %
   \yquant@futurenonspacelet\yquant@env@begin@next\yquant@env@begin@checkarg%
}

{\catcode`\^^M=12 \global\let\yquant@env@linebreak=^^M}

\protected\def\yquant@env@begin@checkarg{%
   \catcode`\^^M=5 %
   \ifx\yquant@env@begin@next[%
      \expandafter\yquant@env@begin@arg%
   \else%
      \ifx\yquant@env@begin@next\yquant@env@linebreak%
         % In this case we don't really want to inject the wrong-catcode linebreak back,
         % which would produce an error.
         \afterassignment\yquant@env@begin@noarg%
         \expandafter\expandafter\expandafter\let%
         \expandafter\expandafter\expandafter\@eattoken%
         % since ^^M is an ordinary character, no need for "= ".
      \else%
         \expandafter\expandafter\expandafter\yquant@env@begin@noarg%
      \fi%
   \fi%
}

\def\yquant@env@begin@noarg{%
   \yquant@env@begin@arg[]%
}

\def\yquant@env@begin@arg{%
   \let\yquant@env@check=\yquant@env@check@%
   \yquant@env@begin@generic\yquant%
}

\long\protected\def\yquant@env@begin@generic#1[#2]{
   \begingroup%
      \let\yquant@parent=\yquant@prefix%
      \global\advance\yquant@env by 1 %
      \edef\yquant@prefix{yquant@env\the\yquant@env @}%
      \ifnum\yquant@env=1 %
         \yquant@env@substikz#1%
         \def\yquant@env@create@x{0pt}%
         \global\cslet{\yquant@prefix parameters}\empty%
      \else%
         \let\yquant@lang@reset@attrs@inputoutput=\yquant@lang@reset@attrs@inputoutput@subcircuit%
         \let\yquant@env@create@x=\yquant@circuit@operator@x%
         \global\cslet{\yquant@prefix parameters}\yquant@circuit@subcircuit@param%
         \yquant@env@lazyfalse% forbid lazy register creation in subcircuits. We need a proper and in-order declaration of the subcircuit's interface.
      \fi%
      \let#1=\yquant@env@scan%
      \yquant@env@reset@commands%
      \csgdef{\yquant@prefix registers}{0}%
      \global\cslet{\yquant@prefix draw}\relax%
      \global\cslet{\yquant@prefix outputs}\relax%
      \csdimgdef{\yquant@prefix xmin}{\yquant@env@create@x+\yquant@config@operator@sep}%
      \global\cslet{\yquant@prefix subcircuits}\empty%
      \global\cslet{\yquant@prefix inonly}\empty%
      \csxdef{\yquant@prefix cleanup}{%
         \expandafter\noexpand\csname\yquant@prefix registers\endcsname%
         \expandafter\noexpand\csname\yquant@prefix draw\endcsname%
         \expandafter\noexpand\csname\yquant@prefix outputs\endcsname%
         \expandafter\noexpand\csname\yquant@prefix parameters\endcsname%
         \expandafter\noexpand\csname\yquant@prefix xmin\endcsname%
         \expandafter\noexpand\csname\yquant@prefix subcircuits\endcsname%
         \expandafter\noexpand\csname\yquant@prefix inonly\endcsname%
         \expandafter\noexpand\csname\yquant@prefix cleanup\endcsname%
      }%
      \scope[{/yquant/.cd, #2, /tikz/.cd, /yquant/every circuit}]%
}

\protected\def\yquant@env@end{%
         \letcs\yquant@env@end@registers{\yquant@prefix registers}%
         \ifnum\yquant@env@end@registers>0 %
            % draw all wires
            \yquant@register@get@maxxrange\yquant@env@end@xpos{1}{\yquant@env@end@registers}%
            \ifdim\csname\yquant@prefix xmin\endcsname<%
                  \dimexpr\yquant@env@create@x+\yquant@config@operator@sep\relax%
               % to have a symmetric situation, we extend again one separation at the end
               \dimdef\yquant@env@end@xpos{\yquant@env@end@xpos+\yquant@config@operator@sep}%
               \global\cslet{\yquant@prefix xmax}\yquant@env@end@xpos%
            \else%
               % while the outputs need this, the subcircuit doesn't if there are no outputs.
               \global\cslet{\yquant@prefix xmax}\yquant@env@end@xpos%
               \dimdef\yquant@env@end@xpos{\yquant@env@end@xpos+\yquant@config@operator@sep}%
            \fi%
            \yquant@cleanup@csadd{xmax}%
            \csxappto{\yquant@prefix draw}{%
               \yquant@circuit@endwires{\yquant@env@end@xpos}%
            }%
            \csname\yquant@prefix outputs\endcsname%
            % also calculate the true y positions
            \unless\ifdefined\yquant@parent%
               \yquant@env@end@calcypositions%
            \fi%
         \else%
            \ifdefined\yquant@parent%
               \PackageError{yquant.sty}{Empty subcircuit}%
                            {Subcircuits must contain registers.}%
            \else%
               \PackageWarning{yquant.sty}{Empty quantum circuit}%
            \fi%
         \fi%
         \global\let\yquant@env@scan=\relax% don't rescan after the scope
      \endscope% this will exit five to seven groups (depending on the transparency group state, and it might even be driver-dependent, though it is not at the moment), so better make the relax global
      \global\let\yquant@env@scan=\yquant@env@scan@%
      \ifdefined\yquant@parent%
         % We are in a subcircuit. The drawing and cleanup is delayed until the end.
         \csxappto{\yquant@parent cleanup}%
            {\unexpanded\expandafter\expandafter\expandafter{%
               \csname\yquant@prefix cleanup\endcsname%
            }}%
         \ifyquantdebug%
            \csshow{\yquant@prefix draw}%
         \fi%
      \else%
         % Now we actually carry out the tikz commands which were previously stored in the draw command. But before this, we get rid of all \yquant@env@scan calls and also restore the scope command, since this would add itself once again. And get@y needs to expand.
         \let\path=\tikz@command@path%
         \let\tikz@lib@scope@check=\yquant@env@substikz@scopecheck%
         \let\tikz@scope@opt=\yquant@env@substikz@scope%
         \let\endtikz@scope@env=\yquant@env@substikz@endscope%
         \let\endscope=\endtikz@scope@env%
         \let\stopscope=\endscope%
         \yquant@register@get@y@@expandable%
         \ifyquantdebug%
            \csshow{\yquant@prefix draw}%
         \fi%
         \csname\yquant@prefix draw\endcsname%
         \expandafter\expandafter\expandafter\yquant@cleanup\csname\yquant@prefix cleanup\endcsname|%
         \global\yquant@env=0 %
      \fi%
   \endgroup%
}

\protected\def\yquant@env@end@calcypositions{%
   \begingroup%
      \dimen4=\yquant@config@register@sep %
      % We know the heights of most gates, but subcircuits are tricky. Since the position of their inner wires depends on the heights of the outer wires, we could not make any assumption about their heights yet. So we now need multiple iterations: First, we fix the positions of our own wires preliminarily. Then, we iterate through all subcircuits at the first level, place their wires appropriately and try to align input and output. In doing so, we recognize when there's not enough space at an outer wire. If this is the case, we enlarge the outer wire's height appropriately and restart alignment from the outmost level. If everything is proper, we start aligning at the next level.
      \yquant@env@end@calcypositions@toplevel1%
      % Turn the preliminary positions into true ones at every level.
      \yquant@env@end@setypositions1%
   \endgroup%
}

\protected\def\yquant@env@end@calcypositions@loop#1{%
   % \yquant@parent has to be set already
   \def\yquant@prefix{yquant@env#1@}%
   % #1 now holds the id of the subcircuit. Find the first input.
   \edef\firstinput{%
      \expandafter\expandafter\expandafter%
         \@firstoftwo\csname\yquant@prefix firstinput\endcsname%
   }%
   \edef\lastinput{%
      \expandafter\expandafter\expandafter%
         \@firstoftwo\csname\yquant@prefix lastinput\endcsname%
   }%
   % we already made sure during in \yquant@circuit@subcircuit that there is enough space above and below the subcircuit. Still, the wires need to be positioned. However, we will first deal with all intermediate wires, which need to be placed by means of shifts - there is no direct correspondence to heights or depths of parent wires any more.
   \ifnum\firstinput<\numexpr\lastinput-1\relax%
      \dimen0=\dimexpr%
         \csname y@\csname\yquant@prefix registermap@\firstinput\endcsname\endcsname+%
         \yquant@register@get@depth\firstinput+\dimen4%
      \relax%
      \yquant@for \i := \numexpr\firstinput+1\relax to \lastinput {%
         \advance\dimen0 by \yquant@register@get@height\i\relax%
         \ifcsname\yquant@prefix registermap@\i\endcsname%
            % this is an input: do we have enough space by using the outer position?
            \letcs\outername{\yquant@prefix registermap@\i}%
            \letcs\outery{y@\outername}%
            \ifdim\dimen0>\outery\relax%
               % re-aligning the outer positions is required
               \ifcsname y+@\outername\endcsname%
                  \csdimdef{y+@\outername}%
                           {\csname y+@\outername\endcsname+\dimen0-\outery}%
               \else%
                  \csdimdef{y+@\outername}{\dimen0-\outery}%
               \fi%
               \let\yquant@env@end@calcypositions@redo=\relax%
            \fi%
         \else%
            \csedef{y@\yquant@prefix register@\i}{\the\dimen0}%
         \fi%
         \ifdefined\yquant@env@end@calcypositions@redo%
            \expandafter\yquant@for@break%
         \else%
            \advance\dimen0 by \dimexpr\yquant@register@get@depth\i+\dimen4\relax%
         \fi%
      }%
   \fi%
   \unless\ifdefined\yquant@env@end@calcypositions@redo%
      % sounds good, no readjustments necessary. Now transfer the wires above and below in the appropriate macros.
      \ifnum\firstinput>1 %
         \dimen0=\dimexpr%
            \csname y@\csname\yquant@prefix registermap@\firstinput\endcsname\endcsname-%
            \yquant@register@get@height\firstinput-\dimen4%
         \relax%
         \yquant@fordown \i := \numexpr\firstinput-1\relax downto 1 {%
            \advance\dimen0 by -\yquant@register@get@depth\i\relax%
            \csedef{y@\yquant@prefix register@\i}{\the\dimen0}%
            \advance\dimen0 by -\dimexpr\yquant@register@get@height\i+\dimen4\relax%
         }%
      \fi%
      \ifnum\lastinput<\csname\yquant@prefix registers\endcsname%
         \dimen0=\dimexpr%
            \csname y@\csname\yquant@prefix registermap@\lastinput\endcsname\endcsname+%
            \yquant@register@get@depth\lastinput+\dimen4%
         \relax%
         \yquant@for \i := \numexpr\lastinput+1\relax to \csname\yquant@prefix registers\endcsname {%
            \advance\dimen0 by \yquant@register@get@height\i\relax%
            \csedef{y@\yquant@prefix register@\i}{\the\dimen0}%
            \advance\dimen0 by \dimexpr\yquant@register@get@depth\i+\dimen4\relax%
         }%
      \fi%
   \fi%
   \ifdefined\yquant@env@end@calcypositions@redo%
      % forget every plan about going deeper, restart.
      \expandafter\listbreak%
   \else%
      \expandafter\yquant@env@end@calcypositions@subcircuits%
   \fi%
}

\protected\def\yquant@env@end@calcypositions@subcircuits{%
   \let\yquant@parent=\yquant@prefix%
   \forlistcsloop\yquant@env@end@calcypositions@loop{\yquant@prefix subcircuits}%
   \ifdefined\yquant@env@end@calcypositions@redo%
      \expandafter\listbreak%
   \fi%
}

\protected\def\yquant@env@end@calcypositions@toplevel{%
   \def\yquant@prefix{yquant@env1@}%
   \dimen0=0pt %
   \yquant@for \i := 1 to \yquant@env@end@registers {%
      % we do not care if the wire is present for the y position
      \advance\dimen0 by \yquant@register@get@height\i\relax%
      \ifcsname y+@\yquant@prefix register@\i\endcsname%
         \advance\dimen0 by \csname y+@\yquant@prefix register@\i\endcsname\relax%
      \fi%
      \csedef{y@\yquant@prefix register@\i}{\the\dimen0}%
      \advance\dimen0 by \dimexpr\yquant@register@get@depth\i+\dimen4\relax%
   }%
   \undef\yquant@env@end@calcypositions@redo%
   \let\yquant@parent=\yquant@prefix%
   \forlistcsloop\yquant@env@end@calcypositions@loop{\yquant@prefix subcircuits}%
   \ifdefined\yquant@env@end@calcypositions@redo%
      \expandafter\yquant@env@end@calcypositions@toplevel%
   \fi%
}

\protected\def\yquant@env@end@setypositions#1{%
   \def\yquant@prefix{yquant@env#1@}%
   \yquant@for \i := 1 to \csname\yquant@prefix registers\endcsname {%
      \unless\ifcsname\yquant@prefix registermap@\i\endcsname%
         \yquant@register@set@y\i{-\csname y@\yquant@prefix register@\i\endcsname}%
      \fi%
   }%
   \forlistcsloop\yquant@env@end@setypositions{\yquant@prefix subcircuits}%
}

\tikzaddtikzonlycommandshortcutlet\yquant\yquant@envunstar
\expandafter\tikzaddtikzonlycommandshortcutlet\csname yquant*\endcsname\yquant@envstar
\tikzaddtikzonlycommandshortcutlet\endyquant\yquant@env@end
\expandafter\tikzaddtikzonlycommandshortcutlet\csname endyquant*\endcsname\yquant@env@end

\protected\def\yquantset{%
   \pgfqkeys{/yquant}%
}
\let\yquant@set=\yquantset%

% In order to allow nested environments and also grouping (without the need to smuggle definitions out of the groups whenever necessary), we count the number of nested environments.
\newcount\yquant@env

% Some commands may be overwritten while a subcircuit is processed, in particular attributes, but also some others. However, within the subcircuit, they need to have their original (un)definition.
\protected\def\yquant@env@reset@commands{%
   \yquant@lang@reset@attrs%
   \yquant@register@reset@multi%
}

\protected\def\yquant@env@substikz@finish{%
   % Rendering pipeline
   \endgroup%
   \global\pgflinewidth=\tikzscope@linewidth\relax%
   \tikz@path@do@at@end%
}

% first undoes the substikz commands, next turns the \path command into a virtual one that does not produce any output.
\protected\def\yquant@env@virtualize@path{%
   \yquant@register@get@y@@expandable%
   \let\path=\tikz@command@path%
   \let\tikz@finish=\yquant@env@substikz@finish%
   \let\tikz@lib@scope@check=\yquant@env@substikz@scopecheck%
}

% substitute the tikz commands (defined in \tikz@installcommands) so that they can be arbitrarily interleaved with yquant code. We patch \path, \scope, \endscope, \stopscope, their internal complements, and also patch \yquantset.
\protected\def\yquant@env@substikz#1{%
   % \tikz@path@do@at@end is called after a path. Hence, it is an ideal candidate to re-invoke \yquant@env@scan. However, it is by default defined to be \tikz@lib@scope@check, and we need this definition for the scopes library to work correctly. But since \tikz@lib@scope@check is also called after a scope and the end of a scope, this is even better. Yet, we need to check whether the scopes library is present or not.
   \let\yquant@env@substikz@scopecheck=\tikz@lib@scope@check%
   \ifx\tikz@lib@scope@check\pgfutil@empty%
      % no, it is not. This is simple.
      \def\tikz@lib@scope@check{\yquant@env@scan}%
   \else%
      % yes, it is. Call it after the special behavior is done.
      \patchcmd\tikz@lib@scope@check{{}}{\yquant@env@scan}\relax{%
         \PackageWarning{yquant.sty}{Patching \string\tikz@lib@scope@check\space failed; you must invoke \string\yquant\space manually after every tikz command to switch back to yquant code.}%
      }%
   \fi%
   % We not only need to re-invoke yquant after the tikz command, but we must also make sure that the tikz command is not actually drawn now, but at the end. However, what happens if some macros are used within the command? Here, we choose to expand the macros to the values they have _now_, but protected (which should prevent bad things for formatting commands). If you find this to be an issue, please report.
   \def\path##1;{%
      \protected@csxappto{\yquant@prefix draw}{%
         \noexpand\path##1;%
      }%
      #1%
   }%
   % no need for \scoped, because it internally calls \scope.
   % We need to hack into \scope, but this is a bit tricky due to its argument handling. In order to get all optional arguments, including the possible animations library, correct, we change \tikz@scope@opt.
   \ifdefined\tikz@scope@opt%
      \let\yquant@env@substikz@scope=\tikz@scope@opt%
      \def\tikz@scope@opt[##1]{%
         \protected@csxappto{\yquant@prefix draw}{%
            \noexpand\tikz@scope@env[{##1}]%
         }%
         \yquant@env@substikz@scope[{##1}]%
      }%
   \else%
      % this is for the arXiv, which has a very outdated version of TikZ
      \let\yquant@env@substikz@scope=\tikz@@scope@env%
      \def\tikz@@scope@env[##1]{%
         \protected@csxappto{\yquant@prefix draw}{%
            \noexpand\tikz@@scope@env[{##1}]%
         }%
         \yquant@env@substikz@scope[{##1}]%
      }%
   \fi%
   \let\yquant@env@substikz@endscope=\endtikz@scope@env%
   \def\endtikz@scope@env{%
      \csgappto{\yquant@prefix draw}{%
         \yquant@env@substikz@endscope%
      }%
      \yquant@env@substikz@endscope%
   }%
   \let\endscope=\endtikz@scope@env%
   \let\stopscope=\endscope%
   % We define \yquantset as a pgfkeys-like macro. Anything else would deteriorate performance badly, as \pgfkeys, \pgfqkeys, or \tikzset are used a lot internally.
   \protected\def\yquantset##1{%
      \protected@csxappto{\yquant@prefix draw}{%
         \noexpand\pgfqkeys{/yquant}{##1}%
      }%
      \pgfqkeys{/yquant}{##1}%
      \yquant@env@scan%
   }%
}

% Scan until the next non-space token is found and execute it as a csname
\def\yquant@env@scan{%
   \begingroup%
      \yquant@env@contscan%
}
\let\yquant@env@scan@=\yquant@env@scan

\protected\def\yquant@env@contscan{%
   \yquant@futurenonspacelet\yquant@env@nextchar\yquant@env@check%
}

\def\yquant@env@rescan{%
   \endgroup%
   \yquant@env@scan%
}

\protected\def\yquant@env@check@{%
   \let\next=\relax%
   % Here we assume standard catcodes for A and [, but our language specification also requires this implicitly.
   \ifx\yquant@env@nextchar[%
      \let\next=\yquant@langhelper@check@attrs%
   \else%
      \ifcat\noexpand\yquant@env@nextchar A% letter
         \let\next=\yquant@langhelper@check@name%
      \else%
         \ifcat\noexpand\yquant@env@nextchar\bgroup%
            \endgroup%
            \let\next=\yquant@env@opengroup%
         \else%
            \ifcat\noexpand\yquant@env@nextchar\egroup%
               \endgroup%
               \let\next=\yquant@env@closegroup%
            \else%
               \ifx\yquant@env@nextchar\par%
                  \let\next=\yquant@env@gobblepar%
               \else%
                  \ifcat\noexpand\yquant@env@nextchar\relax%
                     \endgroup%
                     \let\next=\relax%
                  \else%
                     \PackageError{yquant.sty}%
                        {Invalid yquant syntax: `\meaning\yquant@env@nextchar'}%
                        {Adhere to the specs!}%
                  \fi%
               \fi%
            \fi%
         \fi%
      \fi%
   \fi%
   \next%
}

\protected\def\yquant@env@opengroup{%
   \afterassignment\yquant@env@opengroup@aux%
   \let\@eattoken= %
}

\def\yquant@env@opengroup@aux{%
   \bgroup%
      \csgappto{\yquant@prefix draw}{\begingroup}%
      \yquant@env@scan%
}

\def\yquant@env@closegroup{%
   \csgappto{\yquant@prefix draw}{\endgroup}%
   \aftergroup\yquant@env@scan%
}

\def\yquant@env@gobblepar{%
   \afterassignment\yquant@env@contscan%
   \let\@eattoken= %
}

\def\yquantimport@now#1{%
   \expandafter\yquant\@@input #1\relax%
}

\def\yquantimportcommand{\yquantimport@now}%

\AtBeginDocument{%
   % do we have the import package?
   \ifdefined\@doimport%
      \providecommand\yquantimportpath{./}%
      \def\yquantimportcommand{\@doimport\yquantimport@now{\yquantimportpath}}%
   \fi%
}

\def\yquantimport{%
   \@ifstar{\yquantimport@i{*}}{\yquantimport@i{}}%
}

\def\yquantimport@i#1{%
   \@ifnextchar[{\yquantimport@ii{#1}}{\yquantimport@ii{#1}[]}%
}%

\def\yquantimport@ii#1[#2]#3{%
   \ifpgfpicture%
      \ifnum\yquant@env>0 %
         \begingroup%
            \ifstrequal{#1}{*}{%
               \yquant@env@lazytrue%
            }{%
               \yquant@env@lazyfalse%
            }%
            \ifstrempty{#2}{%
               \yquantimportcommand{#3}%
            }{%
               \scope%
                  \yquantset{#2}%
                  \yquantimportcommand{#3}%
               \endscope%
            }%
         \endgroup%
         \expandafter\expandafter\expandafter\yquant%
      \else%
         \begin{yquant#1}[{#2}]
            \yquantimportcommand{#3}%
         \end{yquant#1}%
      \fi%
   \else%
      \begin{tikzpicture}%
         \begin{yquant#1}[{#2}]
            \yquantimportcommand{#3}%
         \end{yquant#1}%
      \end{tikzpicture}
   \fi%
}