third_party/blink/renderer/core/css/css_image_set_value.h

/*
 * Copyright (C) 2012 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:
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS 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 APPLE INC. OR ITS 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.
 */

#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_CSS_CSS_IMAGE_SET_VALUE_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_CSS_CSS_IMAGE_SET_VALUE_H_

#include "third_party/blink/renderer/core/css/css_value_list.h"
#include "third_party/blink/renderer/core/css/parser/css_parser_mode.h"
#include "third_party/blink/renderer/platform/cross_origin_attribute_value.h"
#include "third_party/blink/renderer/platform/loader/fetch/fetch_parameters.h"
#include "third_party/blink/renderer/platform/weborigin/referrer.h"
#include "third_party/blink/renderer/platform/wtf/allocator.h"

namespace blink {

class Document;
class StyleImage;

class CSSImageSetValue : public CSSValueList {
 public:
  static CSSImageSetValue* Create(CSSParserMode parser_mode) {
    return MakeGarbageCollected<CSSImageSetValue>(parser_mode);
  }

  explicit CSSImageSetValue(CSSParserMode);
  ~CSSImageSetValue();

  bool IsCachePending(float device_scale_factor) const;
  StyleImage* CachedImage(float device_scale_factor) const;
  StyleImage* CacheImage(
      const Document&,
      float device_scale_factor,
      FetchParameters::ImageRequestOptimization,
      CrossOriginAttributeValue = kCrossOriginAttributeNotSet);

  String CustomCSSText() const;

  struct ImageWithScale {
    DISALLOW_NEW();
    String image_url;
    Referrer referrer;
    float scale_factor;
  };

  CSSImageSetValue* ValueWithURLsMadeAbsolute();

  bool HasFailedOrCanceledSubresources() const;

  void TraceAfterDispatch(blink::Visitor*);

 protected:
  ImageWithScale BestImageForScaleFactor(float scale_factor);

 private:
  void FillImageSet();
  static inline bool CompareByScaleFactor(ImageWithScale first,
                                          ImageWithScale second) {
    return first.scale_factor < second.scale_factor;
  }

  float cached_scale_factor_;
  Member<StyleImage> cached_image_;

  CSSParserMode parser_mode_;
  Vector<ImageWithScale> images_in_set_;
};

DEFINE_CSS_VALUE_TYPE_CASTS(CSSImageSetValue, IsImageSetValue());

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_CORE_CSS_CSS_IMAGE_SET_VALUE_H_