\section{Script\-Module Class Reference} \label{class_script_module}\index{ScriptModule@{Script\-Module}} This class is used for generic cc\-Script {\bf DSO} {\rm (p.\,\pageref{class_d_s_o})} plugins. cc\-Script loadable module. {\tt \#include $<$script.h$>$} \subsection*{Protected Methods} \begin{CompactItemize} \item virtual void {\bf module\-Attach} ({\bf Script\-Interp} $\ast$interp) \begin{CompactList}\small\item\em Method to call for handling script attach events.\item\end{CompactList}\item virtual void {\bf module\-Detach} ({\bf Script\-Interp} $\ast$interp) \begin{CompactList}\small\item\em Method to call for handling script detach events.\item\end{CompactList}\item virtual char $\ast$ {\bf get\-Session} ({\bf Script\-Interp} $\ast$interp, {\bf scriptline\_\-t} $\ast$line, {\bf Script\-Session} $\ast$$\ast$session) \begin{CompactList}\small\item\em Check for script handler.\item\end{CompactList}\item virtual char $\ast$ {\bf check\-Script} ({\bf scriptline\_\-t} $\ast$line, {\bf Script\-Image} $\ast$img) \begin{CompactList}\small\item\em Validate script command for parser.\item\end{CompactList}\item {\bf Script\-Module} (const char $\ast$name) \begin{CompactList}\small\item\em Construct and link-in a command handler.\item\end{CompactList}\end{CompactItemize} \subsection*{Static Protected Methods} \begin{CompactItemize} \item Script\-Module $\ast$ {\bf find} (const char $\ast$name) \begin{CompactList}\small\item\em Find a given module.\item\end{CompactList}\end{CompactItemize} \subsection*{Friends} \begin{CompactItemize} \item class {\bf Script\-Interp} \item class {\bf Script\-Command} \end{CompactItemize} \subsection{Detailed Description} This class is used for generic cc\-Script {\bf DSO} {\rm (p.\,\pageref{class_d_s_o})} plugins. cc\-Script loadable module. This allows plugins to become part of the base cc\-Script engine. \begin{Desc} \item[Author: ]\par David Sugar $<${\tt dyfet@ostel.com}$>$ \end{Desc} \subsection{Constructor \& Destructor Documentation} \index{ScriptModule@{Script\-Module}!ScriptModule@{ScriptModule}} \index{ScriptModule@{ScriptModule}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}Script\-Module::Script\-Module (const char $\ast$ {\em name})\hspace{0.3cm}{\tt [protected]}}\label{class_script_module_b4} Construct and link-in a command handler. \begin{Desc} \item[Parameters: ]\par \begin{description} \item[{\em name}]of command being created. \end{description} \end{Desc} \subsection{Member Function Documentation} \index{ScriptModule@{Script\-Module}!checkScript@{checkScript}} \index{checkScript@{checkScript}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual char$\ast$ Script\-Module::check\-Script ({\bf scriptline\_\-t} $\ast$ {\em line}, {\bf Script\-Image} $\ast$ {\em img})\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{class_script_module_b3} Validate script command for parser. \begin{Desc} \item[Returns: ]\par error string or NULL if ok. \end{Desc} \begin{Desc} \item[Parameters: ]\par \begin{description} \item[{\em script}]line evaluated. \item[{\em image}]set analyzed. \end{description} \end{Desc} \index{ScriptModule@{Script\-Module}!find@{find}} \index{find@{find}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}Script\-Module$\ast$ Script\-Module::find (const char $\ast$ {\em name})\hspace{0.3cm}{\tt [static, protected]}}\label{class_script_module_e0} Find a given module. \begin{Desc} \item[Returns: ]\par module found. \end{Desc} \begin{Desc} \item[Parameters: ]\par \begin{description} \item[{\em module}]name. \end{description} \end{Desc} \index{ScriptModule@{Script\-Module}!getSession@{getSession}} \index{getSession@{getSession}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual char$\ast$ Script\-Module::get\-Session ({\bf Script\-Interp} $\ast$ {\em interp}, {\bf scriptline\_\-t} $\ast$ {\em line}, {\bf Script\-Session} $\ast$$\ast$ {\em session})\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{class_script_module_b2} Check for script handler. \begin{Desc} \item[Returns: ]\par error string. \end{Desc} \begin{Desc} \item[Parameters: ]\par \begin{description} \item[{\em interpreter}]image. \item[{\em line}]object parsed. \item[{\em pointer}]to session handler. \end{description} \end{Desc} \index{ScriptModule@{Script\-Module}!moduleAttach@{moduleAttach}} \index{moduleAttach@{moduleAttach}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Script\-Module::module\-Attach ({\bf Script\-Interp} $\ast$ {\em interp})\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{class_script_module_b0} Method to call for handling script attach events. \begin{Desc} \item[Parameters: ]\par \begin{description} \item[{\em interpreter}]being attached. \end{description} \end{Desc} \index{ScriptModule@{Script\-Module}!moduleDetach@{moduleDetach}} \index{moduleDetach@{moduleDetach}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}virtual void Script\-Module::module\-Detach ({\bf Script\-Interp} $\ast$ {\em interp})\hspace{0.3cm}{\tt [inline, protected, virtual]}}\label{class_script_module_b1} Method to call for handling script detach events. \begin{Desc} \item[Parameters: ]\par \begin{description} \item[{\em interpreter}]being detached. \end{description} \end{Desc} \subsection{Friends And Related Function Documentation} \index{ScriptModule@{Script\-Module}!ScriptCommand@{ScriptCommand}} \index{ScriptCommand@{ScriptCommand}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class Script\-Command\hspace{0.3cm}{\tt [friend]}}\label{class_script_module_l1} \index{ScriptModule@{Script\-Module}!ScriptInterp@{ScriptInterp}} \index{ScriptInterp@{ScriptInterp}!ScriptModule@{Script\-Module}} \subsubsection{\setlength{\rightskip}{0pt plus 5cm}friend class Script\-Interp\hspace{0.3cm}{\tt [friend]}}\label{class_script_module_l0} The documentation for this class was generated from the following file:\begin{CompactItemize} \item {\bf script.h}\end{CompactItemize}