OpenNet
Public Member Functions | List of all members
OpenNet::SourceCode Class Reference

The SourceCode class. More...

#include <SourceCode.h>

Inheritance diagram for OpenNet::SourceCode:
OpenNet::Function OpenNet::Kernel OpenNet::Function_Forward OpenNet::Kernel_Forward

Public Member Functions

OPEN_NET_PUBLIC SourceCode ()
 Constructor.
 
virtual OPEN_NET_PUBLIC ~SourceCode ()
 Destructor.
 
OPEN_NET_PUBLIC Status AppendCode (const char *aFileName)
 Append code using a source file. More...
 
virtual OPEN_NET_PUBLIC Status AppendCode (const char *aCode, unsigned int aCodeSize_byte)
 Appen code. More...
 
OPEN_NET_PUBLIC Status AppendCode (const SourceCode &aCode)
 Appen code. More...
 
OPEN_NET_PUBLIC unsigned int GetCodeSize () const
 Get code size. More...
 
OPEN_NET_PUBLIC const char * GetName () const
 Retrieve the instance name. More...
 
virtual OPEN_NET_PUBLIC Status ResetCode ()
 Reset the code. More...
 
virtual OPEN_NET_PUBLIC Status SetArgumentCount (unsigned int aArgCount)
 Set the number of argument for the function or kernel. More...
 
virtual OPEN_NET_PUBLIC Status SetCode (const char *aFileName)
 Set the code using a source file. More...
 
virtual OPEN_NET_PUBLIC Status SetCode (const char *aCode, unsigned int aCodeSize_byte)
 Set the code. More...
 
OPEN_NET_PUBLIC Status SetName (const char *aName)
 Set the instance's name. More...
 
virtual OPEN_NET_PUBLIC Status Display (FILE *aOut) const
 Display. More...
 
virtual OPEN_NET_PUBLIC unsigned int Edit_Remove (const char *aSearch)
 Remove strings from code. More...
 
virtual OPEN_NET_PUBLIC unsigned int Edit_Replace (const char *aSearch, const char *aReplace)
 Replace strings in code. More...
 
OPEN_NET_PUBLIC unsigned int Edit_Search (const char *aSearch)
 Search string in code. More...
 

Detailed Description

The SourceCode class.

Member Function Documentation

OPEN_NET_PUBLIC Status OpenNet::SourceCode::AppendCode ( const char *  aFileName)

Append code using a source file.

Parameters
aFileNameThe source file name
Return values
STATUS_OK
STATUS_CANNOT_OPEN_INPUT_FILE
STATUS_CANNOT_READ_INPUT_FILE
STATUS_CODE_ALREADY_SET
STATUS_EMPTY_INPUT_FILE
STATUS_ERROR_CLOSING_INPUT_FILE
STATUS_ERROR_READING_INPUT_FILE
STATUS_INPUT_FILE_TOO_LARGE
virtual OPEN_NET_PUBLIC Status OpenNet::SourceCode::AppendCode ( const char *  aCode,
unsigned int  aCodeSize_byte 
)
virtual

Appen code.

Parameters
aCodeThe code
aCodeSize_byteLa taille du code
Return values
STATUS_OK
STATUS_CODE_ALREADY_SET
STATUS_EMPTY_CODE

Reimplemented in OpenNet::Kernel.

OPEN_NET_PUBLIC Status OpenNet::SourceCode::AppendCode ( const SourceCode aCode)

Appen code.

Parameters
aCodeThe code
Return values
STATUS_OK
STATUS_CODE_ALREADY_SET
STATUS_EMPTY_CODE
virtual OPEN_NET_PUBLIC Status OpenNet::SourceCode::Display ( FILE *  aOut) const
virtual

Display.

Parameters
aOutThe output stream
Return values
STATUS_OK
STATUS_NOT_ALLOWER_NULL_ARGUMENT

Reimplemented in OpenNet::Kernel, OpenNet::Function_Forward, OpenNet::Kernel_Forward, and OpenNet::Function.

virtual OPEN_NET_PUBLIC unsigned int OpenNet::SourceCode::Edit_Remove ( const char *  aSearch)
virtual

Remove strings from code.

Parameters
aSearchThe string to search for and remove
Returns
This method returns the number of removed string.

Reimplemented in OpenNet::Kernel.

virtual OPEN_NET_PUBLIC unsigned int OpenNet::SourceCode::Edit_Replace ( const char *  aSearch,
const char *  aReplace 
)
virtual

Replace strings in code.

Parameters
aSearchThe string to search for
aReplaceThe string to use for replacing found strings
Returns
This method returns the number of replacement.

Reimplemented in OpenNet::Kernel.

OPEN_NET_PUBLIC unsigned int OpenNet::SourceCode::Edit_Search ( const char *  aSearch)

Search string in code.

Parameters
aSearchThe string to search for
Returns
This method returns the number of fount occurence.
OPEN_NET_PUBLIC unsigned int OpenNet::SourceCode::GetCodeSize ( ) const

Get code size.

Returns
The code size in byte
OPEN_NET_PUBLIC const char* OpenNet::SourceCode::GetName ( ) const

Retrieve the instance name.

Returns
This methode returns the address of an internal buffer.
virtual OPEN_NET_PUBLIC Status OpenNet::SourceCode::ResetCode ( )
virtual

Reset the code.

Return values
STATUS_OK
STATUS_CODE_NOT_SET

Reimplemented in OpenNet::Kernel.

virtual OPEN_NET_PUBLIC Status OpenNet::SourceCode::SetArgumentCount ( unsigned int  aArgCount)
virtual

Set the number of argument for the function or kernel.

Parameters
aArgCountThis argument indicates how many arguments must be passed to the code.
Return values
STATUS_OK
virtual OPEN_NET_PUBLIC Status OpenNet::SourceCode::SetCode ( const char *  aFileName)
virtual

Set the code using a source file.

Parameters
aFileNameThe source file name
Return values
STATUS_OK
STATUS_CANNOT_OPEN_INPUT_FILE
STATUS_CANNOT_READ_INPUT_FILE
STATUS_CODE_ALREADY_SET
STATUS_EMPTY_INPUT_FILE
STATUS_ERROR_CLOSING_INPUT_FILE
STATUS_ERROR_READING_INPUT_FILE
STATUS_INPUT_FILE_TOO_LARGE

Reimplemented in OpenNet::Kernel.

virtual OPEN_NET_PUBLIC Status OpenNet::SourceCode::SetCode ( const char *  aCode,
unsigned int  aCodeSize_byte 
)
virtual

Set the code.

Parameters
aCodeThe code
aCodeSize_byteLa taille du code
Return values
STATUS_OK
STATUS_CODE_ALREADY_SET
STATUS_EMPTY_CODE

Reimplemented in OpenNet::Kernel.

OPEN_NET_PUBLIC Status OpenNet::SourceCode::SetName ( const char *  aName)

Set the instance's name.

Parameters
aNameThe name
Return values
STATUS_OK
STATUS_NOT_ALLOWED_NULL_ARGUMENT

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