PRM_ScriptPage Class Reference

#include <PRM_ScriptPage.h>

Classes
struct	TokenParmCount

Public Types
enum	{   PRM_SCRIPT_RMAN = 0x01, PRM_SCRIPT_SHELL = 0x02, PRM_SCRIPT_VEX = 0x04, PRM_SCRIPT_INVISIBLE = 0x08,   PRM_SCRIPT_INVISIBLETAB = 0x10, PRM_SCRIPT_OBSOLETE = 0x20 }

Public Member Functions
	PRM_ScriptPage ()
virtual	~PRM_ScriptPage ()
int	parse (DS_Stream &is, bool expect_open_brace, PRM_ScriptParm *group_owner_parm, bool parsing_import, bool fix_invalid_joins=true, int multiparm_depth=0)
void	appendScriptParms (UT_ValArray< PRM_ScriptParm * > &parms)
const char *	getToken () const
void	setToken (const char *token)
const char *	getLabel () const
const char *	getDefault () const
PRM_ScriptParm *	getParm (int i)
int	getParmEntries () const
bool	getBaseParm () const
bool	getTabBreak () const
PRM_ConditionalGroup *	getGroupConditional () const
PRM_ConditionalGroup *	getPageConditional () const
PRM_SpareData *	getSpareData (bool create=false)
void	enforceOptions ()
bool	containsReservedName () const
void	setEmptyDefault (const char *str)
void	setFlag (unsigned flag)
void	clearFlag (unsigned flag)
unsigned	getFlag (unsigned bit) const
virtual int	countParameters () const
int	computeTemplateSize ()
void	fillTemplate (PRM_Template *tplate, int &idx, PRM_ScriptImports *&imports)
int	computeObsoleteTemplateSize ()
void	fillObsoleteTemplate (PRM_Template *tplate)

Static Public Attributes
static const TokenParmCount	theTokens []

Protected Member Functions
virtual PRM_ScriptParm *	newParm ()
virtual PRM_ScriptPage *	newImportPage ()
virtual int	parseHelp (DS_Stream &is, UT_String &help)
virtual int	handleUnknown (DS_Stream &is, UT_String &token)
int	parseImport (DS_Stream &is, int multiparm_depth)
void	processImportPage (PRM_ScriptPage *page)
int	parseAttribute (DS_Stream &is)
void	fillTemplate (PRM_Template *tplate, int &idx, PRM_ScriptImports *&imports, int nest_level, int switcher_idx, int folder)

Protected Attributes
UT_String	myToken
UT_String	myLabel
UT_String	myDefault
UT_String	myImportSource
UT_String	myImportToken
UT_String	myImportMask
bool	myImportEnable
UT_ValArray< PRM_ScriptParm * >	myParms
UT_ValArray< PRM_ScriptParm * >	myObsoleteParms
PRM_ScriptImports *	myImports
PRM_ConditionalGroup *	myConditionalPage
PRM_ConditionalGroup *	myConditionalGroup
bool	myBaseParm
bool	myTabBreak
PRM_SpareData *	mySpareData
unsigned	myFlag

Friends
class	PRM_ScriptGroup

Detailed Description

Definition at line 30 of file PRM_ScriptPage.h.

Member Enumeration Documentation

anonymous enum

Enumerator
PRM_SCRIPT_RMAN
PRM_SCRIPT_SHELL
PRM_SCRIPT_VEX
PRM_SCRIPT_INVISIBLE
PRM_SCRIPT_INVISIBLETAB
PRM_SCRIPT_OBSOLETE

Definition at line 38 of file PRM_ScriptPage.h.

Constructor & Destructor Documentation

PRM_ScriptPage::PRM_ScriptPage

(

)

virtual PRM_ScriptPage::~PRM_ScriptPage ( )

virtual

Member Function Documentation

void PRM_ScriptPage::appendScriptParms

(

UT_ValArray< PRM_ScriptParm * > &

parms

)

void PRM_ScriptPage::clearFlag ( unsigned  flag )

inline

Definition at line 86 of file PRM_ScriptPage.h.

int PRM_ScriptPage::computeObsoleteTemplateSize

(

)

int PRM_ScriptPage::computeTemplateSize

(

)

bool PRM_ScriptPage::containsReservedName

(

)

const

virtual int PRM_ScriptPage::countParameters ( ) const

virtual

void PRM_ScriptPage::enforceOptions

(

)

void PRM_ScriptPage::fillObsoleteTemplate

(

PRM_Template *

tplate

)

void PRM_ScriptPage::fillTemplate	(	PRM_Template *	tplate,
		int &	idx,
		PRM_ScriptImports *&	imports
	)

void PRM_ScriptPage::fillTemplate ( PRM_Template *  tplate, int &  idx, PRM_ScriptImports *&  imports, int  nest_level, int  switcher_idx, int  folder  )

protected

bool PRM_ScriptPage::getBaseParm ( ) const

inline

Definition at line 67 of file PRM_ScriptPage.h.

const char* PRM_ScriptPage::getDefault ( ) const

inline

Definition at line 64 of file PRM_ScriptPage.h.

unsigned PRM_ScriptPage::getFlag ( unsigned  bit ) const

inline

Definition at line 87 of file PRM_ScriptPage.h.

PRM_ConditionalGroup* PRM_ScriptPage::getGroupConditional ( ) const

inline

Definition at line 69 of file PRM_ScriptPage.h.

const char* PRM_ScriptPage::getLabel ( ) const

inline

Definition at line 63 of file PRM_ScriptPage.h.

PRM_ConditionalGroup* PRM_ScriptPage::getPageConditional ( ) const

inline

Definition at line 71 of file PRM_ScriptPage.h.

PRM_ScriptParm* PRM_ScriptPage::getParm ( int  i )

inline

Definition at line 65 of file PRM_ScriptPage.h.

int PRM_ScriptPage::getParmEntries ( ) const

inline

Definition at line 66 of file PRM_ScriptPage.h.

PRM_SpareData* PRM_ScriptPage::getSpareData

(

bool

create = false

)

bool PRM_ScriptPage::getTabBreak ( ) const

inline

Definition at line 68 of file PRM_ScriptPage.h.

const char* PRM_ScriptPage::getToken ( ) const

inline

Definition at line 61 of file PRM_ScriptPage.h.

virtual int PRM_ScriptPage::handleUnknown ( DS_Stream &  is, UT_String &  token  )

protectedvirtual

virtual PRM_ScriptPage* PRM_ScriptPage::newImportPage ( )

protectedvirtual

virtual PRM_ScriptParm* PRM_ScriptPage::newParm ( )

protectedvirtual

int PRM_ScriptPage::parse	(	DS_Stream &	is,
		bool	expect_open_brace,
		PRM_ScriptParm *	group_owner_parm,
		bool	parsing_import,
		bool	fix_invalid_joins = true,
		int	multiparm_depth = 0
	)

normally, we are parsing the whole stream & thus expect the opening brace. However, a derived Reader might want to read some meta data, then hand off to us, in which case expect_open_brace will be false.

int PRM_ScriptPage::parseAttribute ( DS_Stream &  is )

protected

virtual int PRM_ScriptPage::parseHelp ( DS_Stream &  is, UT_String &  help  )

protectedvirtual

int PRM_ScriptPage::parseImport ( DS_Stream &  is, int  multiparm_depth  )

protected

void PRM_ScriptPage::processImportPage ( PRM_ScriptPage *  page )

protected

void PRM_ScriptPage::setEmptyDefault ( const char *  str )

inline

Definition at line 79 of file PRM_ScriptPage.h.

void PRM_ScriptPage::setFlag ( unsigned  flag )

inline

Definition at line 85 of file PRM_ScriptPage.h.

void PRM_ScriptPage::setToken ( const char *  token )

inline

Definition at line 62 of file PRM_ScriptPage.h.

Friends And Related Function Documentation

friend class PRM_ScriptGroup

friend

Definition at line 119 of file PRM_ScriptPage.h.

Member Data Documentation

bool PRM_ScriptPage::myBaseParm

protected

Definition at line 148 of file PRM_ScriptPage.h.

PRM_ConditionalGroup* PRM_ScriptPage::myConditionalGroup

protected

Definition at line 147 of file PRM_ScriptPage.h.

PRM_ConditionalGroup* PRM_ScriptPage::myConditionalPage

protected

Definition at line 146 of file PRM_ScriptPage.h.

UT_String PRM_ScriptPage::myDefault

protected

Definition at line 138 of file PRM_ScriptPage.h.

unsigned PRM_ScriptPage::myFlag

protected

Definition at line 151 of file PRM_ScriptPage.h.

bool PRM_ScriptPage::myImportEnable

protected

Definition at line 142 of file PRM_ScriptPage.h.

UT_String PRM_ScriptPage::myImportMask

protected

Definition at line 141 of file PRM_ScriptPage.h.

PRM_ScriptImports* PRM_ScriptPage::myImports

protected

Definition at line 145 of file PRM_ScriptPage.h.

UT_String PRM_ScriptPage::myImportSource

protected

Definition at line 139 of file PRM_ScriptPage.h.

UT_String PRM_ScriptPage::myImportToken

protected

Definition at line 140 of file PRM_ScriptPage.h.

UT_String PRM_ScriptPage::myLabel

protected

Definition at line 137 of file PRM_ScriptPage.h.

UT_ValArray<PRM_ScriptParm *> PRM_ScriptPage::myObsoleteParms

protected

Definition at line 144 of file PRM_ScriptPage.h.

UT_ValArray<PRM_ScriptParm *> PRM_ScriptPage::myParms

protected

Definition at line 143 of file PRM_ScriptPage.h.

PRM_SpareData* PRM_ScriptPage::mySpareData

protected

Definition at line 150 of file PRM_ScriptPage.h.

bool PRM_ScriptPage::myTabBreak

protected

Definition at line 149 of file PRM_ScriptPage.h.

UT_String PRM_ScriptPage::myToken

protected

Definition at line 136 of file PRM_ScriptPage.h.

const TokenParmCount PRM_ScriptPage::theTokens[]

static

a list of tokens not handled by PRM_ScriptPage, but which may be handled by my subclasses or should at least be ignored without generating an error. Each token contains the expected parameter count. Negative values indicate tokens that take brace-enclosed blocks.

Definition at line 116 of file PRM_ScriptPage.h.

---

The documentation for this class was generated from the following file:

• PRM/PRM_ScriptPage.h