xref: /aosp_15_r20/external/parameter-framework/upstream/parameter/SelectionCriterionRule.h (revision c33452fb792a5495ec310a9626f2638b053af5dd)

/*
 * Copyright (c) 2011-2014, Intel Corporation
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation and/or
 * other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#pragma once

#include "Rule.h"

#include <string>

class CSelectionCriterion;

class CSelectionCriterionRule : public CRule
{
    // Matching rules
    enum MatchesWhen
    {
        EIs,
        EIsNot,
        EIncludes,
        EExcludes,

        ENbMatchesWhen
    };
    // Matching rule description
    struct SMatchingRuleDescription
    {
        const char *pcMatchesWhen;
        bool bExclusiveTypeCompatible;
    };

public:
    // Parse
    bool parse(CRuleParser &ruleParser, std::string &strError) override;

    // Dump
    std::string dump() const override;

    // Rule check
    bool matches() const override;

    // From IXmlSink
    bool fromXml(const CXmlElement &xmlElement,
                 CXmlSerializingContext &serializingContext) override;

    // From IXmlSource
    void toXml(CXmlElement &xmlElement, CXmlSerializingContext &serializingContext) const override;

    // Class kind
    std::string getKind() const override;

protected:
    // Content dumping
    std::string logValue(utility::ErrorContext &errorContext) const override;

private:
    // XML MatchesWhen attribute parsing
    bool setMatchesWhen(const std::string &strMatchesWhen, std::string &strError);

    // Selection criterion
    const CSelectionCriterion *_pSelectionCriterion{nullptr};

    // MatchesWhen
    MatchesWhen _eMatchesWhen{EIs};

    // Value
    uint64_t _iMatchValue{0};

    // Used for XML MatchesWhen attribute parsing
    static const SMatchingRuleDescription _astMatchesWhen[ENbMatchesWhen];
};