PDG_AttributeQuery.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.
 *
 * COMMENTS:
 */

#ifndef __PDG_ATTRIBUTE_QUERY_H__
#define __PDG_ATTRIBUTE_QUERY_H__

#include "PDG_API.h"

#include <UT/UT_Array.h>
#include <UT/UT_StringHolder.h>

class UT_WorkBuffer;

/**
 * Stores a list of parsed attribute query tokens, to speed up evaluation
 * when matching the same query across multiple parm expression evaluations
 */
class PDG_API PDG_AttributeQuery
{
public:
    /// Query entry, with a pre-parsed integer value to avoid having to
    /// parse the string each time the query is applied to an attribute.
    struct Entry
    {
        UT_StringHolder myString;
        exint           myInteger;
        bool            myHasInteger;
    };

    using EntryArray    = UT_Array<Entry>;

    /// Constructs an empty query, which can be initialized later from a
    /// string
                            PDG_AttributeQuery();

    /// Constructs a new query from an input string in the form
    /// first.second.3.third... etc
                            explicit PDG_AttributeQuery(
                                const char* query_string);
    
    /// Builds a query from the specified string
    void                    initialize(const char* query_string);

    /// Returns the parsed entries
    const EntryArray&       entries() const
                                { return myQueryEntries; }

    /// Returns the size of the query
    exint                   size() const
                                { return myQueryEntries.size(); }

    /// Returns the raw query string
    const UT_StringHolder&  query() const
                                { return myQueryString; }

    /// Returns the query string up to the specified index
    UT_StringHolder         queryIndex(exint index) const;

private:
    UT_StringHolder         myQueryString;
    EntryArray              myQueryEntries;
};

#endif