PDG_BasePattern.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_BASE_PATTERN_H__
#define __PDG_BASE_PATTERN_H__

#include "PDG_API.h"

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

/**
 * Base class for pattern matching utilities
 */
class PDG_API PDG_BasePattern
{
public:
    /// Constructs a default-initialized, invalid pattern. 
                                PDG_BasePattern(const UT_StringHolder& pattern)
                                    : myPattern(pattern)
                                    , myIsValid(false) {}

    /// Returns true if the pattern is valid, else false. If the pattern is
    /// invalid the errors() contains a string representation of any parse
    /// errors
    bool                        isValid() const
                                    { return myIsValid; }

    /// If the pattern is invalid, contains parse errors
    const UT_WorkBuffer&        errors() const
                                    { return myErrors; }

    /// Returns the pattern used to construct this object
    const UT_StringHolder&      pattern() const
                                    { return myPattern; }

    /// Returns true if there is a pattern set
    bool                        hasPattern() const
                                    { return myPattern.isstring() &&
                                             !myPattern.isEmpty(); }

    /// Resets the pattern
    void                        reset(const UT_StringHolder& pattern)
                                    {
                                        myPattern = pattern;
                                        myIsValid = false;
                                        myErrors.clear();
                                    }

protected:
    /// Special tokens, in addition to alphanumeric and whitespace
    enum ParseTokens : uint8
    {
        /// Star token for globbing
        eStarToken = '*',

        /// Exclusion token
        eExcludeToken = '^',

        /// Type or range split token
        eSeparatorToken = ':',

        /// Value range token
        eRangeToken = '-',

        /// Double quote token
        eQuoteToken = '"',

        /// Escape token
        eEscapeToken = '\\',

        /// Range begin token
        eRangeBeginToken = '[',

        /// Range end token
        eRangeEndToken = ']',

        /// Attribute name token
        eAttributeToken = '@',

        /// Attribute component token
        eComponentToken = '.',
    };

protected:
    /// Parse errors
    UT_WorkBuffer               myErrors;

    /// The pattern used to construct this object
    UT_StringHolder             myPattern;

    /// Whether or not the pattern is valid
    bool                        myIsValid;
};

#endif