author Iulian Moraru <>
Fri, 07 May 2021 22:40:08 +0300
changeset 578910 950445712e58889c9ed92c22d63e5ee0e6880fec
parent 468610 07a87bbee9ca37c2852b620e52b62679719e64f4
permissions -rw-r--r--
Backed out changeset 7f3071ee22e0 (bug 1710046) for causing gecko decision failure. CLOSED TREE

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

/* code for HTML client-side image maps */

#ifndef nsImageMap_h
#define nsImageMap_h

#include "mozilla/gfx/2D.h"
#include "nsCOMPtr.h"
#include "nsCoord.h"
#include "nsTArray.h"
#include "nsStubMutationObserver.h"
#include "nsIDOMEventListener.h"

class Area;
class nsImageFrame;
class nsIFrame;
class nsIContent;
struct nsRect;

namespace mozilla {
namespace dom {
class HTMLAreaElement;
}  // namespace mozilla

class nsImageMap final : public nsStubMutationObserver,
                         public nsIDOMEventListener {
  typedef mozilla::gfx::DrawTarget DrawTarget;
  typedef mozilla::gfx::ColorPattern ColorPattern;
  typedef mozilla::gfx::StrokeOptions StrokeOptions;


  void Init(nsImageFrame* aImageFrame, nsIContent* aMap);

   * Return the first area element (in content order) for the given aX,aY pixel
   * coordinate or nullptr if the coordinate is outside all areas.
  mozilla::dom::HTMLAreaElement* GetArea(nscoord aX, nscoord aY) const;

   * Return area elements count associated with the image map.
  uint32_t AreaCount() const { return mAreas.Length(); }

   * Return area element at the given index.
  mozilla::dom::HTMLAreaElement* GetAreaAt(uint32_t aIndex) const;

  void Draw(nsIFrame* aFrame, DrawTarget& aDrawTarget,
            const ColorPattern& aColor,
            const StrokeOptions& aStrokeOptions = StrokeOptions());

   * Called just before the nsImageFrame releases us.
   * Used to break the cycle caused by the DOM listener.
  void Destroy();

  // nsISupports

  // nsIMutationObserver

  // nsIDOMEventListener

  nsresult GetBoundsForAreaContent(nsIContent* aContent, nsRect& aBounds);

  using AreaList = AutoTArray<mozilla::UniquePtr<Area>, 8>;

  virtual ~nsImageMap();

  void FreeAreas();

  void UpdateAreas();

  void SearchForAreas(nsIContent* aParent);

  void AddArea(mozilla::dom::HTMLAreaElement* aArea);
  void AreaRemoved(mozilla::dom::HTMLAreaElement* aArea);

  void MaybeUpdateAreas(nsIContent* aContent);

  nsImageFrame* mImageFrame;  // the frame that owns us
  nsCOMPtr<nsIContent> mMap;

  // almost always has some entries
  AreaList mAreas;

  // This is set when we search for all area children and tells us whether we
  // should consider the whole subtree or just direct children when we get
  // content notifications about changes inside the map subtree.
  bool mConsiderWholeSubtree;

#endif /* nsImageMap_h */