Separate the parse, symbol, and token documentation into separate files.

This commit is contained in:
Fred Drake 1998-02-18 15:59:13 +00:00
parent 710c035c05
commit b0df567897
8 changed files with 134 additions and 138 deletions

View File

@ -78,6 +78,8 @@ add new extensions to Python and how to embed it in other applications.
\input{libimp} \input{libimp}
\input{libni} \input{libni}
\input{libparser} \input{libparser}
\input{libsymbol}
\input{libtoken}
\input{libkeyword} \input{libkeyword}
\input{libcode} \input{libcode}
\input{libpprint} \input{libpprint}

View File

@ -78,6 +78,8 @@ add new extensions to Python and how to embed it in other applications.
\input{libimp} \input{libimp}
\input{libni} \input{libni}
\input{libparser} \input{libparser}
\input{libsymbol}
\input{libtoken}
\input{libkeyword} \input{libkeyword}
\input{libcode} \input{libcode}
\input{libpprint} \input{libpprint}

View File

@ -534,8 +534,8 @@ The public interface to the classes is straightforward and should
probably be somewhat more flexible. Each ``major'' block of the probably be somewhat more flexible. Each ``major'' block of the
module is described by an object providing several methods for inquiry module is described by an object providing several methods for inquiry
and a constructor which accepts at least the subtree of the complete and a constructor which accepts at least the subtree of the complete
parse tree which it represents. The \code{ModuleInfo} constructor parse tree which it represents. The \class{ModuleInfo} constructor
accepts an optional \code{\var{name}} parameter since it cannot accepts an optional \var{name} parameter since it cannot
otherwise determine the name of the module. otherwise determine the name of the module.
The public classes include \class{ClassInfo}, \class{FunctionInfo}, The public classes include \class{ClassInfo}, \class{FunctionInfo},
@ -688,70 +688,3 @@ provide additional capabilities.
functions for testing node values} functions for testing node values}
\end{seealso} \end{seealso}
\section{Standard Module \sectcode{symbol}}
\label{module-symbol}
\stmodindex{symbol}
This module provides constants which represent the numeric values of
internal nodes of the parse tree. Unlike most Python constants, these
use lower-case names. 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 additional data object:
\setindexsubitem{(in module symbol)}
\begin{datadesc}{sym_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{seealso}
\seemodule{parser}{second example uses this module}
\end{seealso}
\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}

25
Doc/lib/libsymbol.tex Normal file
View File

@ -0,0 +1,25 @@
\section{Standard Module \sectcode{symbol}}
\label{module-symbol}
\stmodindex{symbol}
This module provides constants which represent the numeric values of
internal nodes of the parse tree. Unlike most Python constants, these
use lower-case names. 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 additional data object:
\setindexsubitem{(in module symbol)}
\begin{datadesc}{sym_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{seealso}
\seemodule{parser}{second example uses this module}
\end{seealso}

38
Doc/lib/libtoken.tex Normal file
View File

@ -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}

View File

@ -534,8 +534,8 @@ The public interface to the classes is straightforward and should
probably be somewhat more flexible. Each ``major'' block of the probably be somewhat more flexible. Each ``major'' block of the
module is described by an object providing several methods for inquiry module is described by an object providing several methods for inquiry
and a constructor which accepts at least the subtree of the complete and a constructor which accepts at least the subtree of the complete
parse tree which it represents. The \code{ModuleInfo} constructor parse tree which it represents. The \class{ModuleInfo} constructor
accepts an optional \code{\var{name}} parameter since it cannot accepts an optional \var{name} parameter since it cannot
otherwise determine the name of the module. otherwise determine the name of the module.
The public classes include \class{ClassInfo}, \class{FunctionInfo}, The public classes include \class{ClassInfo}, \class{FunctionInfo},
@ -688,70 +688,3 @@ provide additional capabilities.
functions for testing node values} functions for testing node values}
\end{seealso} \end{seealso}
\section{Standard Module \sectcode{symbol}}
\label{module-symbol}
\stmodindex{symbol}
This module provides constants which represent the numeric values of
internal nodes of the parse tree. Unlike most Python constants, these
use lower-case names. 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 additional data object:
\setindexsubitem{(in module symbol)}
\begin{datadesc}{sym_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{seealso}
\seemodule{parser}{second example uses this module}
\end{seealso}
\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}

25
Doc/libsymbol.tex Normal file
View File

@ -0,0 +1,25 @@
\section{Standard Module \sectcode{symbol}}
\label{module-symbol}
\stmodindex{symbol}
This module provides constants which represent the numeric values of
internal nodes of the parse tree. Unlike most Python constants, these
use lower-case names. 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 additional data object:
\setindexsubitem{(in module symbol)}
\begin{datadesc}{sym_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{seealso}
\seemodule{parser}{second example uses this module}
\end{seealso}

38
Doc/libtoken.tex Normal file
View File

@ -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}