SemanticConceptList.hpp

/*
 * Copyright 2019-2024 Apple Inc. All rights reserved.
 */
#pragma once
 
#include <inflection/dialog/fwd.hpp>
#include <inflection/dialog/SemanticFeatureConceptBase.hpp>
#include <inflection/dialog/DisplayValue.hpp>
#include <inflection/dialog/SpeakableString.hpp>
#include <string>
#include <vector>
 
class INFLECTION_CLASS_API inflection::dialog::SemanticConceptList
    : public SemanticFeatureConceptBase
{
public:
    typedef SemanticFeatureConceptBase super;
 
private:
    ::std::vector<SemanticFeatureConceptBase*> concepts {  };
    SpeakableString beforeFirst { {} };
    SpeakableString afterFirst { {} };
    SpeakableString itemDelimiter { {} };
    SpeakableString beforeLast { {} };
    SpeakableString afterLast { {} };
    SpeakableString itemPrefix { {} };
    SpeakableString itemSuffix { {} };
    bool avoidAffixRedundancy { true };
 
public:
    void putConstraint(const SemanticFeature& feature, ::std::u16string_view featureValue) override;
    void clearConstraint(const SemanticFeature& feature) override;    
    void reset() override;
 
public: /* protected */
    SpeakableString* getFeatureValue(const SemanticFeature& feature) const override;
 
public:
    int32_t getSize() const;
    const SemanticFeatureConceptBase* get(int32_t index) const;
    const SemanticFeatureConceptBase* operator[](int32_t index) const;
    bool isExists() const override;
    ::std::u16string toString() const override;
 
public:
    SpeakableString* toSpeakableString() const override;
private:
    SpeakableString* toSpeakableString(const SemanticFeature* feature) const;
public:
    SemanticConceptList* clone() const override;
 
    virtual SemanticConceptList* setBeforeFirst(const SpeakableString& value);
 
    virtual SpeakableString getBeforeFirst(const SemanticFeatureConceptBase& first, const SpeakableString& formattedFirst) const;
 
    virtual SemanticConceptList* setAfterFirst(const SpeakableString& value);
 
    virtual SpeakableString getAfterFirst(const SemanticFeatureConceptBase& first, const SpeakableString& formattedFirst, const SemanticFeatureConceptBase& second, const SpeakableString& formattedSecond) const;
 
    virtual SemanticConceptList* setItemDelimiter(const SpeakableString& value);
 
    virtual SpeakableString getItemDelimiter(const SemanticFeatureConceptBase& previous, const SpeakableString& formattedPrevious, const SemanticFeatureConceptBase& next, const SpeakableString& formattedNext) const;
 
    virtual SemanticConceptList* setBeforeLast(const SpeakableString& value);
 
    virtual SpeakableString getBeforeLast(const SemanticFeatureConceptBase& secondToLast, const SpeakableString& formattedSecondToLast, const SemanticFeatureConceptBase& last, const SpeakableString& formattedLast) const;
 
    virtual SemanticConceptList* setAfterLast(const SpeakableString& value);
 
    virtual SpeakableString getAfterLast(const SemanticFeatureConceptBase& last, const SpeakableString& formattedLast) const;
 
    virtual SemanticConceptList* setItemPrefix(const SpeakableString& value);
 
    virtual SpeakableString getItemPrefix(const SemanticFeatureConceptBase& item, const SpeakableString& formattedItem) const;
 
    virtual SemanticConceptList* setItemSuffix(const SpeakableString& value);
 
    virtual SpeakableString getItemSuffix(const SemanticFeatureConceptBase& item, const SpeakableString& formattedItem) const;
 
    virtual void setAvoidItemAffixRedundancy(bool value);
 
public:
    SemanticConceptList(const SemanticFeatureModel* model, const ::std::vector<const SemanticFeatureConceptBase*>& values);
    SemanticConceptList(const SemanticFeatureModel* model, const ::std::vector<SemanticFeatureConceptBase*>& values);
    SemanticConceptList(const SemanticConceptList& other);
    ~SemanticConceptList() override;
private:
    SemanticConceptList& operator=(const SemanticConceptList&) = delete;
};