ODIMPathMatcher.h

/*
 
MIT License
 
Copyright (c) 2017 FMI Open Development / Markus Peura, first.last@fmi.fi
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
 */
/*
Part of Rack development has been done in the BALTRAD projects part-financed
by the European Union (European Regional Development Fund and European
Neighbourhood Partnership Instrument, Baltic Sea Region Programme 2007-2013)
 */
#ifndef ODIM_PATH_MATCHER
#define ODIM_PATH_MATCHER
 
 
//#include <drain/util/Dictionary.h>
#include <drain/util/Flags.h>
#include <drain/util/Range.h>
 
#include "ODIMPath.h"
 
 
namespace rack {
 
/*
 *  Index range [index,indexMax] is applied in testing path elements of a same group.
 *  \see ODIMPathMatcher
 */
class ODIMPathElemMatcher : public ODIMPathElem {
 
public:
 
    inline
    ODIMPathElemMatcher(ODIMPathElem::group_t groups = ROOT, index_t index = 0, index_t indexMax = INDEX_MAX) :
        // ODIMPathElem(group, index),
        // index(index),
        // indexMax(indexMax),
        flags(ODIMPathElem::getDictionary(), this->group, '|'){
        this->group = groups;
        this->index = index;
        this->indexMax = indexMax;
    };
 
 
    inline
    ODIMPathElemMatcher(const ODIMPathElemMatcher &e) :
        // ODIMPathElem(e),
        // index(e.index),
        // indexMax(e.indexMax),
        flags(ODIMPathElem::getDictionary(), this->group, '|') {
        this->group = e.group; // needed?
        this->index = e.index;
        this->indexMax = e.indexMax;
    }
 
    inline
    ODIMPathElemMatcher(const ODIMPathElem &e) :
        // ODIMPathElem(e),
        // index(e.index),
        // indexMax(0xffff),
        flags(ODIMPathElem::getDictionary(), this->group,  '|') {
        this->group  = e.group; // needed?
        this->index = e.index;
        this->indexMax = INDEX_MAX; // ??
    }
 
    inline
    ODIMPathElemMatcher(const std::string &s) :
        //  index(0),
        // indexMax(0xffff),
        flags(ODIMPathElem::getDictionary(), this->group,  '|') {
 
        // TODO: virtual reset(){}
        group = 0;
        index = 0;
        this->indexMax = INDEX_MAX;
        set(s);
    }
 
    virtual
    ~ODIMPathElemMatcher(){};
 
    //  ambiguous! index 5 could mean range 5:5 or 0:0xffff ?
 
 
    virtual
    //bool
    void set(const std::string &s);
 
 
    inline
    bool isSingle() const {
        return (!isIndexed()) || (index == indexMax);
    }
 
    inline
    ODIMPathElemMatcher & operator=(ODIMPathElem::group_t g){
        index = 0;
        indexMax = INDEX_MAX;
        group = g;
        return *this;
    }
 
    inline
    ODIMPathElemMatcher & operator=(const std::string &s){
        index = 0;
        indexMax = INDEX_MAX;
        set(s);
        return *this;
    }
 
 
    bool test(const ODIMPathElem & elem) const;
 
    // Applied only as a upper limit in path matching.
    index_t indexMax;
 
    //drain::Flagger flags;
    //drain::Flagger2<drain::MultiFlagger<group_t> > flags;
    drain::MultiFlagger<group_t, group_t> flags;
 
    virtual
    std::ostream & toStream(std::ostream & sstr) const;
 
    // FUTURE extension:
    typedef drain::Range<index_t> idx_range_t;
 
 
protected:
 
    virtual
    void extractIndex(const std::string &s);
 
 
    virtual
    bool extractPrefix(const std::string &s, bool indexed);
 
 
};
 
 
// Note: Elem, not MatcherElem
template <>
void ODIMPathElem::extractIndex(const std::string &s, ODIMPathElemMatcher::idx_range_t & idx);
 
inline
std::ostream & operator<<(std::ostream & ostr, const ODIMPathElemMatcher & p) {
    p.toStream(ostr);
    return ostr;
}
 
//template <>
//char drain::TextReader::scanSegmentToValue(std::istream & istr, const std::string & endChars, ODIMPathElemMatcher::idx_range_t & dst);
 
 
 
 
class ODIMPathMatcher : public drain::Path<ODIMPathElemMatcher> {
 
public:
 
    ODIMPathMatcher() : drain::Path<ODIMPathElemMatcher>() {
        separator.acceptTrailing = true;
    }
 
    ODIMPathMatcher(const ODIMPathMatcher & matcher) : drain::Path<ODIMPathElemMatcher>(matcher) {
    }
 
    template<typename ... T>
    ODIMPathMatcher(const ODIMPathElem & elem, const T &... rest){
        separator.acceptTrailing = true;
        setElems(elem, rest...);
        //updateBean(); ?
    }
 
    ODIMPathMatcher(const std::string & path){
        separator.acceptTrailing = true;
        set(path);
        //assign(path);
    }
 
    ODIMPathMatcher(const char * path){
        separator.acceptTrailing = true;
        set(path);
        // assign(path);
    }
 
 
    //  void parse(const std::string & path);
 
    bool ensureLimitingSlash();
 
 
    bool isLiteral() const;
 
    void extractPath(ODIMPath & path) const;
 
    bool match(const rack::ODIMPath & path) const;
 
    bool matchHead(const rack::ODIMPath & path) const;
 
    bool matchTail(const rack::ODIMPath & path) const;
 
    bool matchElem(const rack::ODIMPathElem & elem, bool defaultValue = true) const;
 
};
 
 
 
}  // namespace rack
 
 
#endif