regex.h

Go to the documentation of this file.

//
// Copyright 2017 Pixar
//
// Licensed under the Apache License, Version 2.0 (the "Apache License")
// with the following modification; you may not use this file except in
// compliance with the Apache License and the following modification to it:
// Section 6. Trademarks. is deleted and replaced with:
//
// 6. Trademarks. This License does not grant permission to use the trade
//    names, trademarks, service marks, or product names of the Licensor
//    and its affiliates, except as required to comply with Section 4(c) of
//    the License and to reproduce the content of the NOTICE file.
//
// You may obtain a copy of the Apache License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the Apache License with the above modification is
// distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the Apache License for the specific
// language governing permissions and limitations under the Apache License.
//
#ifndef PXR_BASE_ARCH_REGEX_H
#define PXR_BASE_ARCH_REGEX_H

#include "pxr/pxr.h"
#include "pxr/base/arch/api.h"

#include <memory>
#include <string>

PXR_NAMESPACE_OPEN_SCOPE

class ArchRegex {
public:
    enum : unsigned int {
        CASE_INSENSITIVE = 1u,
        GLOB             = 2u
    };

    /// Create an empty regex.
    ArchRegex() = default;

    ArchRegex(ArchRegex &&) noexcept = default;
    ArchRegex(ArchRegex const &) = default;
    ArchRegex &operator=(ArchRegex &&) noexcept = default;
    ArchRegex &operator=(ArchRegex const &) = default;

    /// Create with pattern and optional flags.
    ARCH_API ArchRegex(const std::string& pattern, unsigned int flags = 0);

    /// Destructor.
    ARCH_API ~ArchRegex();

    /// Returns \c true if the regex is valid.
    ARCH_API explicit operator bool() const;

    /// Returns the reason the regex is invalid or the empty string if
    /// it's valid.
    ARCH_API std::string GetError() const;

    /// Returns the flags used to construct the regex.
    ARCH_API unsigned int GetFlags() const;

    /// Returns \c true if the regex matches \p query anywhere, otherwise
    /// returns \c false.
    ARCH_API bool Match(const std::string& query) const;

private:
    class _Impl;
    unsigned int _flags = 0;
    std::string _error;
    std::shared_ptr<const _Impl> _impl;
};

PXR_NAMESPACE_CLOSE_SCOPE

#endif // PXR_BASE_ARCH_REGEX_H