UT_ProgramOptions.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_ProgramOptions.h ( UT Library, C++)
 *
 * COMMENTS:    Wrapper for hboost::program_options.
 */

#ifndef __UT_ProgramOptions__
#define __UT_ProgramOptions__

#include <hboost/program_options.hpp>
#include <SYS/SYS_Math.h>

namespace UT_ProgramOptions = hboost::program_options;

namespace hboost
{
    namespace program_options
    {
        /// Class to implement a multi-token with a fixed number of arguments.
        /// Instead of having a multitoken() parameter which can take any number of
        /// arguments, this can be used to limit the number of arguments to a fixed
        /// range.
        /// Example usage: @code
        ///   // A fixed vector of 2 integers
        ///   ( "res,r", fixedSizeMultiToken<std::vector<int>>(2) )
        ///   // A fixed vector of 2 strings
        ///   ( "colorspace", fixedSizeMultiToken<std::vector<std::string>>(2) )
        ///   // A fixed vector of 3 floats
        ///   ( "position-xyz", fixedSizeMultiToken<std::vector<fpreal>>(3) )
        ///   // Allow 2 or 3 arguments
        ///   ( "uv", fixedSizeMultiToken<std::vector<fpreal>>(2, 3) )
        /// @endcode
        template <typename T, typename charT = char>
        class fixedSizeTypedValue : public program_options::typed_value<T, charT>
        {
            using base = program_options::typed_value<T, charT>;
        public:
            fixedSizeTypedValue(T *t, uint min, uint max=0)
                : myMin(min)
                , myMax(SYSmax(min, max))
                , base(t)
            {
                base::multitoken();
            }
            uint min_tokens() const override final { return myMin; }
            uint max_tokens() const override final { return myMax; }
        private:
            uint        myMin, myMax;
        };

        template <typename T>
        fixedSizeTypedValue<T> *
        fixedSizeMultiToken(uint min, uint max=0)
        {
            return new fixedSizeTypedValue<T>(nullptr, min, max);
        }

        template <typename T>
        fixedSizeTypedValue<T> *
        fixedSizeMultiToken(T *store, uint min, uint max=0)
        {
            return new fixedSizeTypedValue<T>(store, min, max);
        }
    } // namespace program_options
} // namespace hboost

#endif // __UT_ProgramOptions__