Skip to content
This repository has been archived by the owner on Mar 6, 2023. It is now read-only.

Added literate mode. #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added literate mode. #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 61 additions & 15 deletions qsharp.dtx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{qsharp}
%<*package>
[2019/08/27 v0.9.1908.2701 Updated to 0.9 syntax.]
[2019/12/30 v0.10.1912.3001 Added literate mode.]
%</package>
%<*driver>
\documentclass{ltxdoc}
Expand Down Expand Up @@ -66,6 +66,7 @@
% Right brace \} Tilde \~}
%
%
% \changes{v0.10.1912.3001}{2019/12/30}{Added literate mode.}
% \changes{v0.9.1908.2902}{2019/08/29}{Updated to 0.9 syntax.}
% \changes{v0.3.1901.1401}{2019/01/14}{Initial public version.}
% \changes{v0.1}{2018/12/04}{Initial version.}
Expand Down Expand Up @@ -93,17 +94,44 @@
% \section{Examples}
%
% \begin{lstlisting}[style=QSharp]
% namespace Example {
% open Microsoft.Quantum.Intrinsic;
%
% /// # Summary
% /// Prepares $(\ket{00} + \ket{11}) / \sqrt{2}$.
% operation PrepareEntangledPair(left : Qubit, right : Qubit) : Unit
% is Adj + Ctl {
% H(left);
% CNOT(left, right);
% }
% }
% namespace Example {
% open Microsoft.Quantum.Intrinsic;
%
% /// # Summary
% /// Prepares a pair of qubits in an entangled state.
% ///
% /// # Description
% /// Prepares a pair of qubits in the $(\ket{00} + \ket{11}) / \sqrt{2}$
% /// state.
% operation PrepareEntangledPair(left : Qubit, right : Qubit) : Unit
% is Adj + Ctl {
% H(left);
% CNOT(left, right);
% }
% }
% \end{lstlisting}
%
% Optionally, \emph{literate mode} can be used to typeset \qs~syntax like |=>|
% and |<-| using LaTeX symbols.
%
% \begin{lstlisting}[style=LiterateQSharp]
% namespace Example {
% open Microsoft.Quantum.Intrinsic;
%
% operation ForEachTwice<'T, 'U>(op : 'T => 'U, targets : 'T[])
% : ('U, 'U)[] {
% mutable results = new ('U, 'U)[0];
% for (target in targets) {
% set results += (op(target), op(target));
% }
% return results;
% }
%
% function ExceptAt<'T>(index : Int, fn : 'T -> 'T, array : 'T[]) : 'T[] {
% return array w/ index <- fn(array[index]);
% }
%
% }
% \end{lstlisting}
%
% \section{Usage}
Expand All @@ -114,7 +142,7 @@
%
% To use this package to typeset \qs~source with \textsf{listings}, use the |language=QSharp| key when using the |{lstlisting}| environment or the |\lstinput| and |\lstverbatim| macros.
% The \textsf{qsharp} package also provides a |style=qsharp| definition with some additional support for including mathematical notation from \qs~comments.
% For example, the source code listing above was generated using the following \LaTeX~code:
% For example, the first source code listing above was generated using the following \LaTeX~code:
%
% \iffalse
% NB: We need to define a new environment type so that we don't have \end{lstlisting}
Expand All @@ -127,7 +155,11 @@
% open Microsoft.Quantum.Intrinsic;
%
% /// # Summary
% /// Prepares $(\ket{00} + \ket{11}) / \sqrt{2}$.
% /// Prepares a pair of qubits in an entangled state.
% ///
% /// # Description
% /// Prepares a pair of qubits in the $(\ket{00} + \ket{11}) / \sqrt{2}$
% /// state.
% operation PrepareEntangledPair(left : Qubit, right : Qubit) : Unit
% is Adj + Ctl {
% H(left);
Expand All @@ -137,6 +169,8 @@
% \end{lstlisting}
% \end{lsttexlisting}
%
% To enable literate mode, replace |style=QSharp| with |style=LiterateQSharp|.
%
% \subsection{Macros}
%
% \DescribeMacro{\qs}
Expand Down Expand Up @@ -233,8 +267,10 @@
true, false,
PauliI, PauliX, PauliY, PauliZ,
new,
not, and, or,
not, and, or,
w/
},
alsoletter={/},
% Define built-in intrinsics as second-order keywords.
morekeywords=[2]{
H,
Expand Down Expand Up @@ -281,6 +317,16 @@
mathescape=true
}

\lstdefinestyle{LiterateQSharp}{
language=QSharp,
mathescape=true,
literate={<-}{{$\leftarrow$}}1
{->}{{$\rightarrow$}}1
{=>}{{$\Rightarrow$}}2
{+=}{{+\kern-0.1em=}}2
{!=}{{$\ne$}}1
}

% \end{macrocode}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Expand Down