highlightstate.h

//
// Author: Lorenzo Bettini <http://www.lorenzobettini.it>, (C) 2004-2008
//
// Copyright: See COPYING file that comes with this distribution
//

#ifndef HIGHLIGHTSTATE_H_
#define HIGHLIGHTSTATE_H_

#include <deque>
#include <vector>
#include <string>
#include <boost/shared_ptr.hpp>

namespace srchilite {

class HighlightRule;
struct HighlightToken;
struct MatchingParameters;

typedef boost::shared_ptr<HighlightRule> HighlightRulePtr;

typedef std::deque<HighlightRulePtr> RuleList;

typedef std::vector<std::string> ReplacementList;

class HighlightState;

typedef boost::shared_ptr<HighlightState> HighlightStatePtr;

class HighlightState {
    static unsigned int global_id;

    const unsigned int id;

    std::string defaultElement;

    RuleList ruleList;

    bool needsReferenceReplacement;

    HighlightStatePtr originalState;

public:
    HighlightState(const std::string &e = "normal");
    HighlightState(const HighlightState &copy);
    ~HighlightState();

    void addRule(HighlightRulePtr rule);

    HighlightRulePtr replaceRule(RuleList::size_type index,
            HighlightRulePtr rule);

    unsigned int getId() const {
        return id;
    }
    const RuleList &getRuleList() const {
        return ruleList;
    }

    const std::string &getDefaultElement() const {
        return defaultElement;
    }
    void setDefaultElement(const std::string &e) {
        defaultElement = e;
    }

    bool findBestMatch(const std::string &s, HighlightToken &token,
            const MatchingParameters &params) const;

    bool findBestMatch(std::string::const_iterator start,
            std::string::const_iterator end, HighlightToken &token,
            const MatchingParameters &params) const;

    static bool betterThan(const HighlightToken &t1, const HighlightToken &t2);

    void replaceReferences(const ReplacementList &rep);

    bool getNeedsReferenceReplacement() const {
        return needsReferenceReplacement;
    }

    void setNeedsReferenceReplacement(bool b = true) {
        needsReferenceReplacement = b;
    }

    HighlightStatePtr getOriginalState() const {
        return originalState;
    }

    void setOriginalState(HighlightStatePtr orig) {
        originalState = orig;
    }

};

}

#endif /*HIGHLIGHTSTATE_H_*/