From 0ea5fc66924303d1bf73ba283a383e2aadee02f2 Mon Sep 17 00:00:00 2001 From: neodarz Date: Sat, 11 Aug 2018 20:21:34 +0200 Subject: Initial commit --- docs/doxygen/nel/a03355.html | 717 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 717 insertions(+) create mode 100644 docs/doxygen/nel/a03355.html (limited to 'docs/doxygen/nel/a03355.html') diff --git a/docs/doxygen/nel/a03355.html b/docs/doxygen/nel/a03355.html new file mode 100644 index 00000000..1c03a30d --- /dev/null +++ b/docs/doxygen/nel/a03355.html @@ -0,0 +1,717 @@ + + +NeL: NLAISCRIPT::IScriptDebugSource class Reference + + + +

NLAISCRIPT::IScriptDebugSource Class Reference

#include <script_debug_source.h> +

Inheritance diagram for NLAISCRIPT::IScriptDebugSource: +

+ + + + + + + + + +

Detailed Description

+IScriptDebugSource is an interface for the script source code. It give methode to use it, wether it comes from a file or from the memory.

Author:: Gabriel ROBERT
+Nevrax France

Date:: 2001

+ +

+Definition at line 42 of file script_debug_source.h. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Public Member Functions
virtual const IBasicType * clone () const=0
sint32 decRef ()
Decrement the reference of an object.

virtual void getDebugString (std::string &) const=0
virtual const std::string getInfo ()
const sint32 & getRef () const
get the refence count.

virtual std::string getSourceBuffer () const=0
Return the entire source buffer.

virtual std::string getSourceName () const
Return a name for the script source.

virtual const CIdentType & getType () const=0
void incRef ()
Inc a reference. We use this when we have to conserve a pointer memeory for exemple in a list.

IScriptDebugSource (const char *sourceName)
Constructor.

virtual void load (NLMISC::IStream &)=0
Load the class from a stream.

virtual const IBasicType * newInstance () const=0
virtual void release ()
Release allow to release the pointer. The last release when the _Ref is nul delete the object.

virtual void save (NLMISC::IStream &)=0
Save the class in a stream.

virtual void serial (NLMISC::IStream &f) throw (NLMISC::EStream)

Protected Attributes
std::string _SourceName
+

Constructor & Destructor Documentation

+ + + + +
+ + + + + + + + + + +
NLAISCRIPT::IScriptDebugSource::IScriptDebugSource ( const char * sourceName )
+
+ + + + + +
+ + + +
+Constructor. +
+ +
+Definition at line 38 of file script_debug_source.cpp. +
+
00038 : +00039 _SourceName(sourceName) +00040 { +00041 } + +

+

Member Function Documentation

+ + + + +
+ + + + + + + + + +
sint32 NLAIC::IPointerGestion::decRef ( ) [inline, inherited]
+
+ + + + + +
+ + + +
+Decrement the reference of an object. +
+ +
+Definition at line 93 of file abstract_interface.h. +
+References NLAIC::IPointerGestion::_Ref, and sint32. +
+Referenced by NLAIC::IPointerGestion::release(), and NLAIAGENT::CAgentTimerHandle::~CAgentTimerHandle(). +
+
00094 { +00095 return --_Ref; +00096 } +

+

+ + + + +
+ + + + + + + + + +
virtual std::string NLAIC::IPointerGestion::getClassName ( ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+ +
+Implements NLMISC::IClassable. +
+Reimplemented in NLAIC::CIdentType. +
+Definition at line 116 of file abstract_interface.h. +
+Referenced by NLAISCRIPT::CAgentClass::isClassInheritedFrom(). +
+
00117 { +00118 return std::string("<unnamed>"); +00119 } +

+

+ + + + +
+ + + + + + + + + +
virtual const std::string NLAIC::IBasicType::getInfo ( ) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+ +
+Definition at line 292 of file abstract_interface.h. +
+References NLAIC::IBasicType::getDebugString(), and s. +
+
00293 { +00294 std::string s; +00295 getDebugString(s); +00296 return s; +00297 } +

+

+ + + + +
+ + + + + + + + + +
const sint32& NLAIC::IPointerGestion::getRef ( ) const [inline, inherited]
+
+ + + + + +
+ + + +
+get the refence count. +
+ +
+Definition at line 99 of file abstract_interface.h. +
+References NLAIC::IPointerGestion::_Ref, and sint32. +
+Referenced by NLAIAGENT::CAgentTimerHandle::~CAgentTimerHandle(). +
+
00100 { +00101 return _Ref; +00102 } +

+

+ + + + +
+ + + + + + + + + +
virtual std::string NLAISCRIPT::IScriptDebugSource::getSourceBuffer ( ) const [pure virtual]
+
+ + + + + +
+ + + +
+Return the entire source buffer. +
+ +
+Implemented in NLAISCRIPT::CScriptDebugSourceFile, and NLAISCRIPT::CScriptDebugSourceMemory. +
+Referenced by NLAISCRIPT::CCodeBrancheRunDebug::printSourceCodeLine().
+

+ + + + +
+ + + + + + + + + +
std::string NLAISCRIPT::IScriptDebugSource::getSourceName ( ) const [virtual]
+
+ + + + + +
+ + + +
+Return a name for the script source. +
+ +
+Definition at line 44 of file script_debug_source.cpp. +
+Referenced by NLAISCRIPT::CCodeBrancheRunDebug::getSourceFileName(). +
+
00045 { +00046 return _SourceName; +00047 } +

+

+ + + + +
+ + + + + + + + + + +
virtual void NLAISCRIPT::IScriptDebugSource::load ( NLMISC::IStream & ) [pure virtual]
+
+ + + + + +
+ + + +
+Load the class from a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Implemented in NLAISCRIPT::CScriptDebugSourceFile, and NLAISCRIPT::CScriptDebugSourceMemory. +
+Referenced by NLAISCRIPT::CCodeBrancheRunDebug::load().
+

+ + + + +
+ + + + + + + + + + +
virtual void NLAISCRIPT::IScriptDebugSource::save ( NLMISC::IStream & ) [pure virtual]
+
+ + + + + +
+ + + +
+Save the class in a stream. +
+ +
+Implements NLAIC::IBasicInterface. +
+Implemented in NLAISCRIPT::CScriptDebugSourceFile, and NLAISCRIPT::CScriptDebugSourceMemory. +
+Referenced by NLAISCRIPT::CCodeBrancheRunDebug::save().
+

+ + + + +
+ + + + + + + + + + +
virtual void NLAIC::IBasicInterface::serial ( NLMISC::IStream & f ) throw (NLMISC::EStream) [inline, virtual, inherited]
+
+ + + + + +
+ + + +
+ +
+Reimplemented from NLAIC::IPointerGestion. +
+Definition at line 328 of file abstract_interface.h. +
+References NLAIC::IBasicInterface::load(), and NLAIC::IBasicInterface::save(). +
+
00329 { +00330 if ( f.isReading() ) +00331 load( f ); +00332 else +00333 save( f ); +00334 } +

+

Field Documentation

+ + + + +
+ + +
std::string NLAISCRIPT::IScriptDebugSource::_SourceName [protected] +
+
+ + + + + +
+ + + +
+ +
+Definition at line 62 of file script_debug_source.h.
+

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

Generated on Tue Mar 16 12:38:45 2004 for NeL by + +

+1.3.6

+ + -- cgit v1.2.1


Public Member Functions
virtual const IBasicType *	clone () const=0
sint32	decRef ()
	Decrement the reference of an object.
virtual void	getDebugString (std::string &) const=0
virtual const std::string	getInfo ()
const sint32 &	getRef () const
	get the refence count.
virtual std::string	getSourceBuffer () const=0
	Return the entire source buffer.
virtual std::string	getSourceName () const
	Return a name for the script source.
virtual const CIdentType &	getType () const=0
void	incRef ()
	Inc a reference. We use this when we have to conserve a pointer memeory for exemple in a list.
	IScriptDebugSource (const char *sourceName)
	Constructor.
virtual void	load (NLMISC::IStream &)=0
	Load the class from a stream.
virtual const IBasicType *	newInstance () const=0
virtual void	release ()
	Release allow to release the pointer. The last release when the _Ref is nul delete the object.
virtual void	save (NLMISC::IStream &)=0
	Save the class in a stream.
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
Protected Attributes
std::string	_SourceName