OP/OP_BundlePattern.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.
 *
 * Produced by:
 *      Mark Elendt
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        OP_BundlePattern.h ( OP Library, C++)
 *
 * COMMENTS:    Pattern tokens for a bundle.  This breaks up the pattern string
 *              into managable tokens which can be processed easily
 */

#ifndef __OP_BundlePattern__
#define __OP_BundlePattern__

#include "OP_API.h"
#include <UT/UT_Assert.h>

class OP_Node;
class OP_BundleFilter;

class OP_API OP_BundlePattern {
public:
    static OP_BundlePattern     *allocPattern(const char *str);
    static void                  freePattern(OP_BundlePattern *pattern);

    int          argc() const   { return myArgc; }
    const char  *argv(int i) const
                 {
                     UT_ASSERT(i >= 0 && i < myArgc);
                     return myArgv[i];
                 }

    bool         hasRelativePath() const        { return myRelativePath; }
    bool         isAsterisk() const             { return myAsterisk; }
    bool         isNullPattern() const          { return myNullPattern; }

    bool         hasPattern(const char *str) const;

    bool         match(const OP_Node *node, const char *relativepath,
                       bool assume_kids_included) const;

    //
    // Raw, single match function.  This can be used in filter traversal.
    bool         matchNode(const OP_Node *node,
                           const char *relativetopath,
                           bool result_if_no_match,
                           int *excluded) const;

protected:
     OP_BundlePattern(const char *str);
    ~OP_BundlePattern();

private:
    const char   *myPatternString;
    char        **myArgv;
    int           myArgc;
    int           myRefCount;
    bool          myRelativePath;
    bool          myAsterisk;
    bool          myNullPattern;
};
#endif

---