CShellCommandHelp Class Reference

#include <ShellCommandHelp.h>

Inheritance diagram for CShellCommandHelp:

Collaboration diagram for CShellCommandHelp:

Public Member Functions
	CShellCommandHelp (CShellCommandsLinkedList &rCommandsLinkedList)
virtual	~CShellCommandHelp ()
virtual BOOL	Match (const TCHAR *pchCommand)
virtual int	Execute (CConsole &rConsole, CArgumentParser &rArguments)
virtual const TCHAR *	GetHelpString ()
virtual const TCHAR *	GetHelpShortDescriptionString ()
Public Member Functions inherited from CShellCommand
	CShellCommand ()
virtual	~CShellCommand ()
virtual BOOL	Match (const TCHAR *pchCommand)=0
virtual int	Execute (CConsole &rConsole, CArgumentParser &rArguments)=0
virtual const TCHAR *	GetHelpString ()=0
virtual const TCHAR *	GetHelpShortDescriptionString ()=0

Private Attributes
CShellCommandsLinkedList &	m_rCommandsLinkedList

Detailed Description

Definition at line 12 of file ShellCommandHelp.h.

Constructor & Destructor Documentation

CShellCommandHelp()

CShellCommandHelp::CShellCommandHelp

(

CShellCommandsLinkedList &

rCommandsLinkedList

)

Definition at line 36 of file ShellCommandHelp.cpp.

                                                                                 :m_rCommandsLinkedList(rCommandsLinkedList)
{
}

~CShellCommandHelp()

CShellCommandHelp::~CShellCommandHelp ( )

virtual

Definition at line 40 of file ShellCommandHelp.cpp.

{
 
}

Member Function Documentation

Execute()

int CShellCommandHelp::Execute ( CConsole &  rConsole, CArgumentParser &  rArguments  )

virtual

Implements CShellCommand.

Definition at line 50 of file ShellCommandHelp.cpp.

{
    const TCHAR *pchArg = rArguments.GetNextArgument();
    CShellCommand *pCommand;
    if (pchArg == NULL)
    {
        POSITION pos = m_rCommandsLinkedList.GetFirstCommandPosition();
        while(pos)
        {
            pCommand = m_rCommandsLinkedList.GetNextCommand(pos);
            rConsole.Write(pCommand->GetHelpShortDescriptionString());
        }
 
        return 0;
    }
 
    if (_tcsicmp(pchArg,_T("GPL")) == 0)
    {
        HRSRC hrcGPL;
        HGLOBAL hGPL;
        char *pchGPL;
        DWORD dwSize;
        if ((hrcGPL = FindResource(NULL, _T("GPL"), _T("LICENSE")))&&
            (hGPL = LoadResource(NULL,hrcGPL))&&
            (pchGPL = (char *)LockResource(hGPL))&&
            (dwSize = SizeofResource(NULL,hrcGPL)))
        {
            // save last char
            char pchSaved[2];
            pchSaved[0] = pchGPL[dwSize-1];
            pchSaved[1] = 0;
 
            // make null-terminated string
            pchGPL[dwSize-1] = 0;
 
            // replace all non-printable chars except CR, LF and HTAB with spaces
            for (DWORD i = 0; i < dwSize ; i++)
                if ((!isprint(pchGPL[i]))&&(pchGPL[i] != '\r')&&(pchGPL[i] != '\n')&&(pchGPL[i] != '\t'))
                    pchGPL[i] = ' ';
 
            rConsole.Write(pchGPL);
            rConsole.Write(pchSaved);
        }
        else
        {
            rConsole.Write(_T("Internal error cannot load GPL.\n"));
        }
        return 0;
    }
 
    while (pchArg)
    {
        pCommand = m_rCommandsLinkedList.Match(pchArg);
        if ((!pCommand)&&((_tcsicmp(pchArg,_T("/?")) == 0)||(_tcsicmp(pchArg,_T("-?")) == 0)))
            pCommand = this;
 
        if (pCommand)
        {
            rConsole.Write(pCommand->GetHelpString());
        }
        else
        {
            rConsole.Write(_T("HELP: Unknown command \""));
            rConsole.Write(pchArg);
            rConsole.Write(_T("\"\n"));
        }
 
        pchArg = rArguments.GetNextArgument();
    }
    return 0;
}

GetHelpShortDescriptionString()

const TCHAR * CShellCommandHelp::GetHelpShortDescriptionString ( )

virtual

Implements CShellCommand.

Definition at line 131 of file ShellCommandHelp.cpp.

{
    return HELP_CMD_SHORT_DESC;
}

GetHelpString()

const TCHAR * CShellCommandHelp::GetHelpString ( )

virtual

Implements CShellCommand.

Definition at line 122 of file ShellCommandHelp.cpp.

{
    return HELP_CMD_SHORT_DESC
            _T("Syntax: ") HELP_CMD _T(" [<COMMAND>] [/?]\n")
            _T("    COMMAND    - Command for which help will be displayed.\n")
            _T("    /?    - This help.\n\n")
            _T("Without parameters, command lists available commands.\n");
}

Match()

BOOL CShellCommandHelp::Match ( const TCHAR *  pchCommand )

virtual

Implements CShellCommand.

Definition at line 45 of file ShellCommandHelp.cpp.

{
    return _tcsicmp(pchCommand,HELP_CMD) == 0;
}

Member Data Documentation

m_rCommandsLinkedList

CShellCommandsLinkedList& CShellCommandHelp::m_rCommandsLinkedList

private

Definition at line 22 of file ShellCommandHelp.h.

Referenced by Execute().

---

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

• modules/rosapps/applications/sysutils/regexpl/ShellCommandHelp.h
• modules/rosapps/applications/sysutils/regexpl/ShellCommandHelp.cpp