UT_ExpandArray.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_ExpandArray.h ( UT Library, C++)
 *
 * COMMENTS:
 *              This class is used to encapsulate the methods
 *              involved with expanding a string pattern.
 */

#ifndef __UT_ExpandArray__
#define __UT_ExpandArray__

#include "UT_API.h"
#include "UT_Assert.h"
#include "UT_String.h"
#include "UT_StringArray.h"
#include "UT_WorkArgs.h"

class UT_API UT_ExpandArray
{

public:

     explicit UT_ExpandArray(int start_size = 256);

    // Returns the number of expanded names
    int                  entries() const
                         { return myExpandedTokens.entries(); }

    // Returns an expanded name
    const char          *operator()(unsigned int i) const
                         {
                             UT_ASSERT_P(i < myExpandedTokens.entries());
                             return myExpandedTokens[i];
                         }

    // Returns the number of parsed argument without expansion
    int                  argEntries(unsigned int i) const
                         { return myTokens.entries(); }

    // Returns a parsed argument without expansion
    const char          *arg(unsigned int i) const
                         {
                             UT_ASSERT_P(i < myTokens.entries());
                             return myTokens[i];
                         }

    // Set a new pattern, clearing the workargs.
    int                  setPattern(const char *pattern, int *dirty_flag=0);
    int                  appendPattern(const char *pattern);

    const UT_String     &getPattern() const
                         { return myPattern; }

    int64                getMemoryUsage(bool inclusive) const;

    // Extract the parsed tokens to a UT_StringArray with or without expansion
    // Returns the number of extracted tokens.
    const UT_StringArray& getTokens() const { return myTokens; }
    const UT_StringArray& getExpandedTokens() const { return myExpandedTokens; }

    void          clear();
private:
    void          setPattern(const char *pattern, int append);

    UT_String     myPattern;
    UT_StringArray myExpandedTokens; // Expanded
    UT_StringArray myTokens; // Without expansion
};

#endif