third_party/WebKit/Source/core/css/resolver/CSSVariableResolver.h

// Copyright 2015 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CSSVariableResolver_h
#define CSSVariableResolver_h

#include "core/CSSPropertyNames.h"
#include "core/css/parser/CSSParserToken.h"
#include "wtf/HashSet.h"
#include "wtf/text/AtomicString.h"
#include "wtf/text/AtomicStringHash.h"

namespace blink {

class CSSParserTokenRange;
class CSSPendingSubstitutionValue;
class CSSVariableData;
class CSSVariableReferenceValue;
class PropertyRegistry;
class StyleResolverState;
class StyleInheritedVariables;
class StyleNonInheritedVariables;

class CSSVariableResolver {
  STACK_ALLOCATED();

 public:
  static void resolveVariableDefinitions(const StyleResolverState&);

  // Shorthand properties are not supported.
  static const CSSValue* resolveVariableReferences(
      const StyleResolverState&,
      CSSPropertyID,
      const CSSValue&,
      bool disallowAnimationTainted);

  static void computeRegisteredVariables(const StyleResolverState&);

  DECLARE_TRACE();

 private:
  CSSVariableResolver(const StyleResolverState&);

  static const CSSValue* resolvePendingSubstitutions(
      const StyleResolverState&,
      CSSPropertyID,
      const CSSPendingSubstitutionValue&,
      bool disallowAnimationTainted);
  static const CSSValue* resolveVariableReferences(
      const StyleResolverState&,
      CSSPropertyID,
      const CSSVariableReferenceValue&,
      bool disallowAnimationTainted);

  // These return false if we encounter a reference to an invalid variable with
  // no fallback.

  // Resolves a range which may contain var() references or @apply rules.
  bool resolveTokenRange(CSSParserTokenRange,
                         bool disallowAnimationTainted,
                         Vector<CSSParserToken>& result,
                         bool& resultIsAnimationTainted);
  // Resolves the fallback (if present) of a var() reference, starting from the
  // comma.
  bool resolveFallback(CSSParserTokenRange,
                       bool disallowAnimationTainted,
                       Vector<CSSParserToken>& result,
                       bool& resultIsAnimationTainted);
  // Resolves the contents of a var() reference.
  bool resolveVariableReference(CSSParserTokenRange,
                                bool disallowAnimationTainted,
                                Vector<CSSParserToken>& result,
                                bool& resultIsAnimationTainted);
  // Consumes and resolves an @apply rule.
  void resolveApplyAtRule(CSSParserTokenRange&, Vector<CSSParserToken>& result);

  // These return null if the custom property is invalid.

  // Returns the CSSVariableData for a custom property, resolving and storing it
  // if necessary.
  CSSVariableData* valueForCustomProperty(AtomicString name);
  // Resolves the CSSVariableData from a custom property declaration.
  PassRefPtr<CSSVariableData> resolveCustomProperty(AtomicString name,
                                                    const CSSVariableData&);

  StyleInheritedVariables* m_inheritedVariables;
  StyleNonInheritedVariables* m_nonInheritedVariables;
  Member<const PropertyRegistry> m_registry;
  HashSet<AtomicString> m_variablesSeen;
  // Resolution doesn't finish when a cycle is detected. Fallbacks still
  // need to be tracked for additional cycles, and invalidation only
  // applies back to cycle starts.
  HashSet<AtomicString> m_cycleStartPoints;
};

}  // namespace blink

#endif  // CSSVariableResolver