cmdHelpVisitor.h

Go to the documentation of this file.

/****************************************************************************** 
 * 
 *  file:  HelpVisitor.h
 * 
 *  Copyright (c) 2003, Michael E. Smoot .
 *  All rights reverved.
 * 
 *  See the file COPYING in the top directory of this distribution for
 *  more information.
 *  
 *  THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS 
 *  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 
 *  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 *  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 *  DEALINGS IN THE SOFTWARE.  
 *  
 *****************************************************************************/ 

#ifndef DtCmdLine_HELP_VISITOR_H
#define DtCmdLine_HELP_VISITOR_H
 

#include "cmdLineInterface.h"
#include "cmdLineOutput.h"
#include "cmdVisitor.h"

#include <vlutil/vlPrint.h>
#include <vlutil/vlProcessControl.h>
#include <vlutil/vlKeyboard.h>

#ifdef DtUSE_UTILITIES_NAMESPACE
namespace DtUSE_UTILITIES_NAMESPACE
{
#endif

namespace DtCmdLine {


   class HelpVisitor: public Visitor
   {
   protected:

      CmdLineInterface* _cmd;

      CmdLineOutput** _out;

      bool myPressAnyKey;

   public:

      HelpVisitor(CmdLineInterface* cmd, CmdLineOutput** out,
#ifdef _WIN32
         bool pressAnyKey = true) 
#else
         bool pressAnyKey = false)
#endif
         : Visitor(), _cmd( cmd ), _out( out ), myPressAnyKey(pressAnyKey) { }

      virtual ~HelpVisitor() { }
      void visit();



   };

   inline void HelpVisitor::visit()
   { 
      (*_out)->usage(*_cmd); 

      int oldNotifyLevel = DtNotifyLevel;
      DtNotifyLevel = 3;


      if (myPressAnyKey)
      {
         DtInfo << "Press any key to continue" << std::endl;

         while (DtPollBlockingInputChar() == '\0')
         {
            DtSleep(0.1);
         }
      }

      DtNotifyLevel = oldNotifyLevel;

      exit(0); 
   }

}

#ifdef DtUSE_UTILITIES_NAMESPACE
}     
#endif

#endif