templateString.h

Go to the documentation of this file.

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_TF_TEMPLATE_STRING_H
#define PXR_BASE_TF_TEMPLATE_STRING_H
 
 
#include "pxr/pxr.h"
 
#include "pxr/base/tf/api.h"
 
#include <tbb/spin_mutex.h>
 
#include <map>
#include <memory>
#include <string>
#include <vector>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TfTemplateString {
public:
    typedef std::map<std::string, std::string> Mapping;
 
    TF_API
    TfTemplateString();
 
    TF_API
    TfTemplateString(const std::string& template_);
 
    const std::string& GetTemplate() const { return _data->template_; }
 
    TF_API
    std::string Substitute(const Mapping&) const;
 
    TF_API
    std::string SafeSubstitute(const Mapping&) const;
 
    TF_API
    Mapping GetEmptyMapping() const;
 
    TF_API
    bool IsValid() const;
 
    TF_API
    std::vector<std::string> GetParseErrors() const;
 
private:
    struct _PlaceHolder {
        _PlaceHolder(const std::string& n, size_t p, size_t l)
            : name(n), pos(p), len(l) {}
        std::string name;
        size_t pos;
        size_t len;
    };
 
    // Returns a new string constructed by performing token replacement.
    std::string _Evaluate(const Mapping&, std::vector<std::string>* = 0) const;
 
    // Finds the next token-like substring in the template and returns the
    // token name, position and length. For token ${foo}, the name is 'foo',
    // position is the position of '$' and length is the length of the entire
    // token including optional enclosing braces.
    bool _FindNextPlaceHolder(size_t*, std::vector<std::string>*) const;
 
    // Find all tokens in the template string and store away naming and
    // position information.
    void _ParseTemplate() const;
 
    // Emit any parse errors as TF_CODING_ERRORs.
    void _EmitParseErrors() const;
 
    // Structure side-allocated and shared between copies.
    struct _Data
    {
        _Data(_Data const &) = delete;
        _Data &operator=(_Data const &) = delete;
 
        _Data() : parsed(false) {}
 
        std::string template_;
        mutable std::vector<_PlaceHolder> placeholders;
        mutable bool parsed;
        mutable std::vector<std::string> parseErrors;
        mutable tbb::spin_mutex mutex;
    };
 
    std::shared_ptr<_Data> _data;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TF_TEMPLATE_STRING_H