summaryrefslogtreecommitdiffstats
path: root/Doc/libtoken.tex
diff options
context:
space:
mode:
authorFred Drake <fdrake@acm.org>1998-02-18 15:59:13 (GMT)
committerFred Drake <fdrake@acm.org>1998-02-18 15:59:13 (GMT)
commitb0df56789762c4c82ac125672263d52de89ec5f7 (patch)
treece0c09797d65c1b385b3b4cac1f03c1dd2c0c12b /Doc/libtoken.tex
parent710c035c057c948513d10486734daa8872430882 (diff)
downloadcpython-b0df56789762c4c82ac125672263d52de89ec5f7.zip
cpython-b0df56789762c4c82ac125672263d52de89ec5f7.tar.gz
cpython-b0df56789762c4c82ac125672263d52de89ec5f7.tar.bz2
Separate the parse, symbol, and token documentation into separate files.
Diffstat (limited to 'Doc/libtoken.tex')
-rw-r--r--Doc/libtoken.tex38
1 files changed, 38 insertions, 0 deletions
diff --git a/Doc/libtoken.tex b/Doc/libtoken.tex
new file mode 100644
index 0000000..816abc7
--- /dev/null
+++ b/Doc/libtoken.tex
@@ -0,0 +1,38 @@
+\section{Standard Module \sectcode{token}}
+\label{module-token}
+\stmodindex{token}
+
+This module provides constants which represent the numeric values of
+leaf nodes of the parse tree (terminal tokens). Refer to the file
+\file{Grammar/Grammar} in the Python distribution for the defintions
+of the names in the context of the language grammar. The specific
+numeric values which the names map to may change between Python
+versions.
+
+This module also provides one data object and some functions. The
+functions mirror definitions in the Python C header files.
+
+\setindexsubitem{(in module token)}
+
+
+\begin{datadesc}{tok_name}
+Dictionary mapping the numeric values of the constants defined in this
+module back to name strings, allowing more human-readable
+representation of parse trees to be generated.
+\end{datadesc}
+
+\begin{funcdesc}{ISTERMINAL}{x}
+Return true for terminal token values.
+\end{funcdesc}
+
+\begin{funcdesc}{ISNONTERMINAL}{x}
+Return true for non-terminal token values.
+\end{funcdesc}
+
+\begin{funcdesc}{ISEOF}{x}
+Return true if \var{x} is the marker indicating the end of input.
+\end{funcdesc}
+
+\begin{seealso}
+\seemodule{parser}{second example uses this module}
+\end{seealso}