UT_Variadic.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_Variadic.h (UT Library, C++)
 *
 * COMMENTS:
 */

#ifndef __UT_Variadic__
#define __UT_Variadic__

#include "UT_Array.h"

/// Build a list of variadic arguments of the given template type
///
/// C-Style variadic arguments are error prone for various reasons:
///     - No type checking
///     - NULL termination issues
///
/// This class provides type-safety and a cleaner interface.  For example, to
/// accept a variable length array of strings: @code
/// typedef UT_VariadicT<const char *>  VariadicStrings;
/// void
/// function(const VariadicStrings &strings)
/// {
///     for (exint i = 0; i < strings.entries(); ++i)
///         cerr << i << " " << strings.item(i) << " " strlen(strings.item(i));
/// }
/// 
/// // Which can be called using
/// function(VariadicStrings() << "hello" << "world");
/// @endcode
template <typename T>
class UT_VariadicT
{
public:

    UT_VariadicT<T> &operator<<(const T &val)
    {
        myItems.append(&val);
        return *this;
    }

    exint       entries() const { return myItems.entries(); }
    const T     &item(exint arg) const  { return *myItems(arg); }

    void        append(const T &v)      { myItems.append(&v); }

protected:
    UT_Array<const T *> myItems;
};

#endif