src/third_party/WebKit/Source/core/html/parser/HTMLSrcsetParser.h

   1 /*
   2  * Copyright (C) 2013 Apple Inc. All rights reserved.
   3  * Copyright (C) 2013 Google Inc. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met:
   8  *
   9  *     * Redistributions of source code must retain the above copyright
  10  * notice, this list of conditions and the following disclaimer.
  11  *     * Redistributions in binary form must reproduce the above
  12  * copyright notice, this list of conditions and the following disclaimer
  13  * in the documentation and/or other materials provided with the
  14  * distribution.
  15  *     * Neither the name of Google Inc. nor the names of its
  16  * contributors may be used to endorse or promote products derived from
  17  * this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  */
  31
  32 #ifndef HTMLSrcsetParser_h
  33 #define HTMLSrcsetParser_h
  34
  35 #include "wtf/text/WTFString.h"
  36
  37 namespace blink {
  38
  39 class Document;
  40
  41 enum { UninitializedDescriptor = -1 };
  42
  43 class DescriptorParsingResult {
  44 public:
  45     DescriptorParsingResult()
  46         : m_density(UninitializedDescriptor)
  47         , m_resourceWidth(UninitializedDescriptor)
  48         , m_resourceHeight(UninitializedDescriptor)
  49     {
  50     }
  51
  52     bool hasDensity() const { return m_density >= 0; }
  53     bool hasWidth() const { return m_resourceWidth >= 0; }
  54     bool hasHeight() const { return m_resourceHeight >= 0; }
  55
  56     float density() const { ASSERT(hasDensity()); return m_density; }
  57     unsigned resourceWidth() const { ASSERT(hasWidth()); return m_resourceWidth; }
  58     unsigned resourceHeight() const { ASSERT(hasHeight()); return m_resourceHeight; }
  59
  60     void setResourceWidth(int width) { ASSERT(width >= 0); m_resourceWidth = (unsigned)width; }
  61     void setResourceHeight(int height) { ASSERT(height >= 0); m_resourceHeight = (unsigned)height; }
  62     void setDensity(float densityToSet) { ASSERT(densityToSet >= 0); m_density = densityToSet; }
  63
  64 private:
  65     float m_density;
  66     int m_resourceWidth;
  67     int m_resourceHeight;
  68 };
  69
  70 class ImageCandidate {
  71 public:
  72     enum OriginAttribute {
  73         SrcsetOrigin,
  74         SrcOrigin
  75     };
  76
  77     ImageCandidate()
  78         : m_density(1.0)
  79         , m_resourceWidth(UninitializedDescriptor)
  80         , m_originAttribute(SrcsetOrigin)
  81     {
  82     }
  83
  84     ImageCandidate(const String& source, unsigned start, unsigned length, const DescriptorParsingResult& result, OriginAttribute originAttribute)
  85         : m_string(source.createView(start, length))
  86         , m_density(result.hasDensity()?result.density():UninitializedDescriptor)
  87         , m_resourceWidth(result.hasWidth()?result.resourceWidth():UninitializedDescriptor)
  88         , m_originAttribute(originAttribute)
  89     {
  90     }
  91
  92     String toString() const
  93     {
  94         return String(m_string.toString());
  95     }
  96
  97     AtomicString url() const
  98     {
  99         return AtomicString(m_string.toString());
 100     }
 101
 102     void setDensity(float factor)
 103     {
 104         m_density = factor;
 105     }
 106
 107     float density() const
 108     {
 109         return m_density;
 110     }
 111
 112     int resourceWidth() const
 113     {
 114         return m_resourceWidth;
 115     }
 116
 117     bool srcOrigin() const
 118     {
 119         return (m_originAttribute == SrcOrigin);
 120     }
 121
 122     inline bool isEmpty() const
 123     {
 124         return m_string.isEmpty();
 125     }
 126
 127 private:
 128     StringView m_string;
 129     float m_density;
 130     int m_resourceWidth;
 131     OriginAttribute m_originAttribute;
 132 };
 133
 134 ImageCandidate bestFitSourceForSrcsetAttribute(float deviceScaleFactor, float sourceSize, const String& srcsetAttribute, Document* = nullptr);
 135
 136 ImageCandidate bestFitSourceForImageAttributes(float deviceScaleFactor, float sourceSize, const String& srcAttribute, const String& srcsetAttribute, Document* = nullptr);
 137
 138 String bestFitSourceForImageAttributes(float deviceScaleFactor, float sourceSize, const String& srcAttribute, ImageCandidate& srcsetImageCandidate);
 139
 140 }
 141
 142 #endif