PronounConcept.hpp

/*
 * Copyright 2022-2024 Apple Inc. All rights reserved.
 */
#pragma once
 
#include <inflection/dialog/fwd.hpp>
#include <inflection/dialog/SemanticFeatureConceptBase.hpp>
#include <inflection/dialog/SemanticFeatureModel_DisplayData.hpp>
#include <inflection/dialog/DisplayValue.hpp>
#include <optional>
#include <memory>
#include <string>
#include <vector>
 
class INFLECTION_CLASS_API inflection::dialog::PronounConcept
    : public SemanticFeatureConceptBase
{
 
public:
    typedef SemanticFeatureConceptBase super;
 
private:
    enum MatchState {
        NO_MATCH,
        GENERIC_MATCH,
        FULL_MATCH
    };
    typedef std::map<std::u16string_view, std::u16string_view> ConstraintData;
    typedef std::pair<std::u16string_view, ConstraintData> PronounEntry;
    struct DefaultPronounData;
    class PronounData;
 
    std::shared_ptr<PronounData> pronounData;
    ::std::map<std::u16string, ::std::u16string> defaultConstraints {  };
    int32_t defaultPronounIndex { -1 };
 
private: /* protected */
    static std::shared_ptr<PronounConcept::DefaultPronounData> createPronounDataForModel(const SemanticFeatureModel& model, const char16_t* const readerCharArray);
    static std::shared_ptr<PronounConcept::DefaultPronounData> getPronounData(const SemanticFeatureModel& model);
    static std::optional<::std::u16string_view> getFeatureValueForPronoun(const PronounConcept::ConstraintData &constraintData, const SemanticFeature& feature);
    bool isMatchingSoundProperty(const ::std::u16string& displayValue, std::u16string_view matchType) const;
    bool isMatchingInitialPronoun() const;
    static MatchState getMatchState(const PronounConcept::ConstraintData& valueConstraintMap, const std::u16string& semanticName, const std::u16string& semanticValue);
    const PronounEntry* getFirstPossibleValue(const inflection::dialog::SemanticFeatureConceptBase* referencedConcept, bool returnDefault, bool matchAll) const;
    const PronounEntry* getCurrentValue(const inflection::dialog::SemanticFeatureConceptBase* referencedConcept, bool returnDefault, bool matchAll) const;
 
public:
    ::inflection::dialog::SpeakableString* getFeatureValue(const SemanticFeature& feature) const override;
 
    bool isExists() const override;
 
    bool isCustomMatch() const;
 
    ::inflection::dialog::SpeakableString* toSpeakableString() const override;
 
    virtual ::inflection::dialog::SpeakableString* toSpeakableString(const inflection::dialog::SemanticFeatureConceptBase& referencedConcept) const;
 
    ::std::u16string toString() const override;
 
    PronounConcept* clone() const override;
 
    bool operator==(const PronounConcept& o) const;
 
    PronounConcept(const SemanticFeatureModel& model, const ::std::vector<::inflection::dialog::DisplayValue>& defaultDisplayData, const ::std::map<SemanticFeature, ::std::u16string>& defaultConstraints);
 
    PronounConcept(const SemanticFeatureModel& model, const ::std::map<SemanticFeature, ::std::u16string>& defaultConstraints);
 
    PronounConcept(const SemanticFeatureModel& model, std::u16string_view initialPronoun);
 
    PronounConcept(const PronounConcept& other);
 
    ~PronounConcept() override;
private:
    static std::map<std::u16string, std::shared_ptr<PronounConcept::DefaultPronounData>>* PRONOUN_DATA_CACHE();
 
    PronounConcept& operator=(const PronounConcept&) = delete;
};