#include <WsfScriptLookup.hpp>

Public Types
enum	StopLocation { cSTOP_AT_LOCATION , cSTOP_AT_END_OF_FUNCTION , cSTOP_AT_END_OF_STATEMENT }
enum	UpdateResult { cNO_SCRIPT , cFAILURE , cSUCCESS , cSUCCESS_NO_CHANGES }
typedef std::map< std::string, UsValRef >	SymbolMap

Public Member Functions
	WsfScriptLookup (Project *aProjectPtr)
	WsfScriptLookup (const WsfScriptLookup &)=delete
	WsfScriptLookup (WsfScriptLookup &&)=default
WsfScriptLookup &	operator= (const WsfScriptLookup &)=delete
WsfScriptLookup &	operator= (WsfScriptLookup &&)=default
	~WsfScriptLookup ()
void	SetScenario (Project *aProjectPtr)
void	SetLocation (UtTextDocumentLocation aLocation, StopLocation aParseStopLocation=cSTOP_AT_LOCATION)
void	SetStoreErrors (bool aStoreErrors)
UpdateResult	Update ()
UsSymbolTable *	GetLocalScope ()
UsSymbol *	Search (const std::string &aSymbolName)
UsType *	FindType (const std::string &aName)
UsType *	GetType (int aTypeId)
bool	AddSymbolsInScope (SymbolMap &aSymbols)
bool	AddSymbolsFromThis (SymbolMap &aSymbols)
bool	AddSymbolsFromBuiltins (SymbolMap &aSymbols)
bool	AddSymbolsFromType (SymbolMap &aSymbols, UsType *aTypePtr)
bool	HasMethodSymbols ()
bool	AddMethodSymbols (SymbolMap &aSymbols)
size_t	GetInsertPosition () const
size_t	GetReplaceCharacters () const
std::string	GetIdentifierLeftOfCursor () const
WsfScriptData *	GetScriptData () const
WsfScriptInfo *	GetScriptInfo () const
UtTextDocumentRange	GetDefinitionLocation (UsSymbol *aSymPtr)
std::vector< WsfScriptParser::ErrorRecord > *	GetErrors ()
std::string	GetFunctionDescription (const std::string &aFunctionName, const UsFunction &aFunc, const std::string &aClassName=std::string())
std::string	GetScriptValDescription (UsValRef aVal)
UtTextDocumentLocation	GetLocation () const
bool	GetCurrentCallInfo (int &aArgNumber, size_t &aOpenParenPos, size_t &aCloseParenPos, std::string &aFunctionName, std::vector< UsFunction > &aFunctionOptions)

Static Public Member Functions
static bool	IdentifierToken (const char aBufferBegin, const char aBufferEnd, size_t aCharOffset, size_t &aBegin, size_t &aEnd)
static UtTextDocumentRange	IdentifierRange (UtTextDocumentLocation aLocation)

Member Typedef Documentation

◆ SymbolMap

typedef std::map<std::string, UsValRef> wizard::WsfScriptLookup::SymbolMap

Member Enumeration Documentation

◆ StopLocation

enum wizard::WsfScriptLookup::StopLocation

Enumerator
cSTOP_AT_LOCATION
cSTOP_AT_END_OF_FUNCTION
cSTOP_AT_END_OF_STATEMENT

◆ UpdateResult

enum wizard::WsfScriptLookup::UpdateResult

Enumerator
cNO_SCRIPT
cFAILURE
cSUCCESS
cSUCCESS_NO_CHANGES

Constructor & Destructor Documentation

◆ WsfScriptLookup() [1/3]

wizard::WsfScriptLookup::WsfScriptLookup ( Project * aProjectPtr )

explicit

References cSTOP_AT_LOCATION.

Referenced by operator=(), operator=(), WsfScriptLookup(), and WsfScriptLookup().

◆ WsfScriptLookup() [2/3]

wizard::WsfScriptLookup::WsfScriptLookup ( const WsfScriptLookup & )

delete

References WsfScriptLookup().

◆ WsfScriptLookup() [3/3]

wizard::WsfScriptLookup::WsfScriptLookup ( WsfScriptLookup && )

default

References WsfScriptLookup().

◆ ~WsfScriptLookup()

wizard::WsfScriptLookup::~WsfScriptLookup ( )

Member Function Documentation

◆ AddMethodSymbols()

bool wizard::WsfScriptLookup::AddMethodSymbols ( SymbolMap & aSymbols )

References UsFunction::cSTATIC, wizard::WsfScriptDetailObserver::cTYPE, HasMethodSymbols(), and UsType::mMethods.

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), and wizard::EditAssist_Script::SetScriptData().

◆ AddSymbolsFromBuiltins()

bool wizard::WsfScriptLookup::AddSymbolsFromBuiltins ( SymbolMap & aSymbols )

References AddSymbolsFromType().

Referenced by wizard::DocumentationInterpretter::FindDocumentation().

◆ AddSymbolsFromThis()

bool wizard::WsfScriptLookup::AddSymbolsFromThis ( SymbolMap & aSymbols )

References AddSymbolsFromType(), and UsSymbolTable::mThisTypePtr.

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), and wizard::EditAssist_Script::SetScriptData().

◆ AddSymbolsFromType()

bool wizard::WsfScriptLookup::AddSymbolsFromType	(	SymbolMap &	aSymbols,
		UsType *	aTypePtr )

References UsType::mMethods.

Referenced by AddSymbolsFromBuiltins(), AddSymbolsFromThis(), and AddSymbolsInScope().

◆ AddSymbolsInScope()

bool wizard::WsfScriptLookup::AddSymbolsInScope ( SymbolMap & aSymbols )

References AddSymbolsFromType().

Referenced by wizard::EditAssist_Script::SetScriptData().

◆ FindType()

UsType * wizard::WsfScriptLookup::FindType ( const std::string & aName )

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), and wizard::EditAssist_Script::SetScriptData().

◆ GetCurrentCallInfo()

bool wizard::WsfScriptLookup::GetCurrentCallInfo	(	int &	aArgNumber,
		size_t &	aOpenParenPos,
		size_t &	aCloseParenPos,
		std::string &	aFunctionName,
		std::vector< UsFunction > &	aFunctionOptions )

References wizard::WsfScriptDetailObserver::CallInfo::mCloseParenPos, wizard::WsfScriptDetailObserver::CallInfo::mCurrentArg, wizard::WsfScriptDetailObserver::CallInfo::mMethodBaseType, wizard::WsfScriptDetailObserver::CallInfo::mMethodName, UsType::mMethods, wizard::WsfScriptDetailObserver::CallInfo::mOpenParenPos, and wizard::WsfScriptDetailObserver::CallInfo::mPrototypeId.

◆ GetDefinitionLocation()

UtTextDocumentRange wizard::WsfScriptLookup::GetDefinitionLocation ( UsSymbol * aSymPtr )

References UsSymbol::cSE_EXTERN, UsSymbolTable::IsInheriting(), UsSymbol::mName, UsSymbol::mPosition, UsSymbol::mStorageType, and UsSymbol::mTablePtr.

Referenced by wizard::EditAssist_Script::SetScriptValRef().

◆ GetErrors()

std::vector< wizard::WsfScriptParser::ErrorRecord > * wizard::WsfScriptLookup::GetErrors ( )

◆ GetFunctionDescription()

std::string wizard::WsfScriptLookup::GetFunctionDescription	(	const std::string &	aFunctionName,
		const UsFunction &	aFunc,
		const std::string &	aClassName = std::string() )

References wizard::WsfScriptTypes::GetConstCtx(), GetScriptData(), UsTypeList::GetTypeName(), UsFunction::mArgs, UsFunction::mReturnType, Us::UsConstCtx::mTypes, wizard::WsfScriptData::mTypesPtr, and DynamicArray< T, ARRAY_SIZE, GROW_SIZE >::size().

Referenced by GetScriptValDescription().

◆ GetIdentifierLeftOfCursor()

std::string wizard::WsfScriptLookup::GetIdentifierLeftOfCursor ( ) const

inline

◆ GetInsertPosition()

size_t wizard::WsfScriptLookup::GetInsertPosition ( ) const

inline

◆ GetLocalScope()

UsSymbolTable * wizard::WsfScriptLookup::GetLocalScope ( )

Referenced by Search().

◆ GetLocation()

UtTextDocumentLocation wizard::WsfScriptLookup::GetLocation ( ) const

inline

Referenced by wizard::EditAssist_Script::SetScriptData().

◆ GetReplaceCharacters()

size_t wizard::WsfScriptLookup::GetReplaceCharacters ( ) const

inline

◆ GetScriptData()

WsfScriptData * wizard::WsfScriptLookup::GetScriptData ( ) const

inline

Referenced by GetFunctionDescription(), GetScriptValDescription(), wizard::EditAssist_Script::SetScriptType(), and wizard::EditAssist_Script::SetScriptValRef().

◆ GetScriptInfo()

WsfScriptInfo * wizard::WsfScriptLookup::GetScriptInfo ( ) const

inline

◆ GetScriptValDescription()

std::string wizard::WsfScriptLookup::GetScriptValDescription ( UsValRef aVal )

References UsTypeList::cPROTOTYPE_ID_START, wizard::WsfScriptTypes::GetConstCtx(), GetFunctionDescription(), UsTypeList::GetPrototype(), GetScriptData(), UsTypeList::GetType(), UsValRef::mFunctionNamePtr, UsValRef::mFunctionTypePtr, UsType::mMethods, UsSymbol::mName, UsType::mName, UsSymbol::mRTypeId, UsValRef::mSymbolPtr, Us::UsConstCtx::mTypes, and wizard::WsfScriptData::mTypesPtr.

Referenced by wizard::EditAssist_Script::SetScriptValRef().

◆ GetType()

UsType * wizard::WsfScriptLookup::GetType ( int aTypeId )

◆ HasMethodSymbols()

bool wizard::WsfScriptLookup::HasMethodSymbols ( )

References wizard::WsfScriptDetailObserver::cTYPE, and UsType::mMethods.

Referenced by AddMethodSymbols().

◆ IdentifierRange()

UtTextDocumentRange wizard::WsfScriptLookup::IdentifierRange ( UtTextDocumentLocation aLocation )

static

References IdentifierToken().

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), and wizard::EditAssist::MakeAssistant().

◆ IdentifierToken()

bool wizard::WsfScriptLookup::IdentifierToken	(	const char *	aBufferBegin,
		const char *	aBufferEnd,
		size_t	aCharOffset,
		size_t &	aBegin,
		size_t &	aEnd )

static

References end(), and WsfParseUtil::IsAlphaNumeric().

Referenced by IdentifierRange().

◆ operator=() [1/2]

WsfScriptLookup & wizard::WsfScriptLookup::operator= ( const WsfScriptLookup & )

delete

References WsfScriptLookup().

◆ operator=() [2/2]

WsfScriptLookup & wizard::WsfScriptLookup::operator= ( WsfScriptLookup && )

default

References SetScenario(), and WsfScriptLookup().

◆ Search()

UsSymbol * wizard::WsfScriptLookup::Search ( const std::string & aSymbolName )

References GetLocalScope(), and UsSymbolTable::Search().

◆ SetLocation()

void wizard::WsfScriptLookup::SetLocation	(	UtTextDocumentLocation	aLocation,
		StopLocation	aParseStopLocation = cSTOP_AT_LOCATION )

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), wizard::EditAssist::MakeAssistant(), and wizard::EditAssist_Script::SetScriptData().

◆ SetScenario()

void wizard::WsfScriptLookup::SetScenario ( Project * aProjectPtr )

Referenced by operator=().

◆ SetStoreErrors()

void wizard::WsfScriptLookup::SetStoreErrors ( bool aStoreErrors )

◆ Update()

wizard::WsfScriptLookup::UpdateResult wizard::WsfScriptLookup::Update ( )

References cFAILURE, cSUCCESS, cSUCCESS_NO_CHANGES, wizard::ParseResultsTiny::mScriptDataPtr, and wizard::ParseResultsTiny::mSequenceNumber.

Referenced by wizard::DocumentationInterpretter::FindDocumentation(), wizard::EditAssist::MakeAssistant(), and wizard::EditAssist_Script::SetScriptData().

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

Public Types

Public Member Functions

Static Public Member Functions

Member Typedef Documentation

◆ SymbolMap

Member Enumeration Documentation

◆ StopLocation

◆ UpdateResult

Constructor & Destructor Documentation

◆ WsfScriptLookup() [1/3]

◆ WsfScriptLookup() [2/3]

◆ WsfScriptLookup() [3/3]

◆ ~WsfScriptLookup()

Member Function Documentation

◆ AddMethodSymbols()

◆ AddSymbolsFromBuiltins()

◆ AddSymbolsFromThis()

◆ AddSymbolsFromType()

◆ AddSymbolsInScope()

◆ FindType()

◆ GetCurrentCallInfo()

◆ GetDefinitionLocation()

◆ GetErrors()

◆ GetFunctionDescription()

◆ GetIdentifierLeftOfCursor()

◆ GetInsertPosition()

◆ GetLocalScope()

◆ GetLocation()

◆ GetReplaceCharacters()

◆ GetScriptData()

◆ GetScriptInfo()

◆ GetScriptValDescription()

◆ GetType()

◆ HasMethodSymbols()

◆ IdentifierRange()

◆ IdentifierToken()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Search()

◆ SetLocation()

◆ SetScenario()

◆ SetStoreErrors()

◆ Update()