XorHandler.h

Go to the documentation of this file.

/****************************************************************************** 
 * 
 *  file:  XorHandler.h
 * 
 *  Copyright (c) 2003, Michael E. Smoot .
 *  Copyright (c) 2004, Michael E. Smoot, Daniel Aarno.
 *  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 TCLAP_XORHANDLER_H
#define TCLAP_XORHANDLER_H

#include <tclap/Arg.h>
#include <tclap/PrintSensibly.h>
#include <string>
#include <vector>
#include <algorithm>
#include <iostream>

namespace TCLAP {

class XorHandler
{
     protected:

          std::vector< std::vector<Arg*> > _orList;

     public:

          XorHandler( ) {}

          void add( std::vector<Arg*>& ors );
               
          int check( const Arg* a );

          std::string shortUsage();

          void printLongUsage(std::ostream& os);

          bool contains( const Arg* a );

};


//BEGIN XOR.cpp
inline void XorHandler::add( std::vector<Arg*>& ors )
{ 
     _orList.push_back( ors );
}

inline std::string XorHandler::shortUsage()
{
        std::string out = "";
     for ( int i = 0; (unsigned int)i < _orList.size(); i++ )
     {
          out += " {";
          for ( ArgVectorIterator it = _orList[i].begin(); 
                              it != _orList[i].end(); it++ )
               out += (*it)->shortID() + "|";

          out[out.length()-1] = '}';
     }

     return out;
}

inline void XorHandler::printLongUsage( std::ostream& os )
{
     for ( int i = 0; (unsigned int)i < _orList.size(); i++ )
     {
          for ( ArgVectorIterator it = _orList[i].begin(); 
                 it != _orList[i].end(); 
                 it++ )
          {
               spacePrint( os, (*it)->longID(), 75, 3, 3 );
               spacePrint( os, (*it)->getDescription(), 75, 5, 0 );

               if ( it+1 != _orList[i].end() )
                    spacePrint(os, "-- OR --", 75, 9);
          }
          os << std::endl << std::endl;
     }
}

inline int XorHandler::check( const Arg* a ) 
{
     // iterate over each XOR list
     for ( int i = 0; (unsigned int)i < _orList.size(); i++ )
     {
          // if the XOR list contains the arg..
          if ( find( _orList[i].begin(), _orList[i].end(), a ) != 
                       _orList[i].end() )
          {
               // go through and set each arg that is not a
               for ( ArgVectorIterator it = _orList[i].begin(); 
                      it != _orList[i].end(); 
                      it++ )  
                    if ( a != (*it) )
                         (*it)->xorSet();

               // return the number of required args that have now been set
               return (int)_orList[i].size();
          }
     }

     if ( a->isRequired() )
          return 1;
     else
          return 0;
}

inline bool XorHandler::contains( const Arg* a )
{
     for ( int i = 0; (unsigned int)i < _orList.size(); i++ )
          for ( ArgVectorIterator it = _orList[i].begin(); 
                 it != _orList[i].end(); 
                 it++ )  
               if ( a == (*it) )
                    return true;

     return false;
}
//END XOR.cpp

} //namespace TCLAP

#endif 

---