Source/WebCore/css/CSSSubstitutionValue.h

// Copyright 2015 The Chromium Authors. All rights reserved.
// Copyright (C) 2016-2021 Apple Inc. All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//    * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//    * 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.
//    * Neither the name of Google Inc. 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
// OWNER 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 <WebCore/CSSNamespacePrefixMap.h>
#include <WebCore/CSSPropertyNames.h>
#include <WebCore/CSSValue.h>
#include <WebCore/CSSValueKeywords.h>
#include <WebCore/CSSVariableData.h>
#include <wtf/text/WTFString.h>

namespace WebCore {

class CSSParserToken;
class CSSParserTokenRange;
struct CSSParserContext;

namespace Style {
class SubstitutionResolver;
}

// A property value containing arbitrary substitution functions (var(), env(), attr(), etc.)
// that need to be resolved during style resolution.
// https://drafts.csswg.org/css-values-5/#arbitrary-substitution
class CSSSubstitutionValue final : public CSSValue {
public:
    static Ref<CSSSubstitutionValue> create(const CSSParserTokenRange&, const CSSNamespacePrefixMap&, const CSSParserContext&);
    static Ref<CSSSubstitutionValue> create(Ref<CSSVariableData>&&);

    bool equals(const CSSSubstitutionValue&) const;
    String customCSSText(const CSS::SerializationContext&) const;

    const CSSParserContext& NODELETE context() const;

    const CSSVariableData& data() const { return m_data.get(); }

    // https://drafts.csswg.org/css-values-5/#funcdef-inherit
    // inherit() reads a value from the parent that may be a property which does not itself inherit,
    // so the cascade has to know a declaration contains one before deciding whether to re-apply it.
    bool containsInheritFunction() const { return m_containsInheritFunction; }

private:
    friend class Style::SubstitutionResolver;

    CSSSubstitutionValue(Ref<CSSVariableData>&&, const CSSNamespacePrefixMap&);

    void cacheSimpleReference();

    const Ref<CSSVariableData> m_data;
    CSSNamespacePrefixMap m_namespacePrefixMap;
    mutable String m_stringValue;

    // For quickly resolving simple substitution functions.
    struct SimpleReference {
        AtomString name;
        CSSValueID functionId;
    };
    std::optional<SimpleReference> m_simpleReference;

    bool m_containsInheritFunction { false };

    struct Cache {
        // For var() case: cache key is the substituted data pointer.
        RefPtr<CSSVariableData> dependencyData;
        // For -internal-auto-base() case: cache key is the base appearance state.
        std::optional<bool> isBaseAppearance;
        RefPtr<CSSValue> value;
        CSSPropertyID propertyID { CSSPropertyInvalid };
    };
    mutable Cache m_cache;
};

} // namespace WebCore

SPECIALIZE_TYPE_TRAITS_CSS_VALUE(CSSSubstitutionValue, isSubstitutionValue())