summaryrefslogtreecommitdiffstats
path: root/layout/generic/DetailsFrame.cpp
blob: 5c62ed5a31488096bfb54dd4c10512fa3b374e2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/* -*- 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 http://mozilla.org/MPL/2.0/. */

#include "DetailsFrame.h"

#include "mozilla/Attributes.h"
#include "mozilla/PresShell.h"
#include "mozilla/dom/HTMLDetailsElement.h"
#include "mozilla/dom/HTMLSummaryElement.h"
#include "nsContentUtils.h"
#include "nsPlaceholderFrame.h"
#include "nsTextNode.h"

using namespace mozilla;
using namespace mozilla::dom;

NS_IMPL_FRAMEARENA_HELPERS(DetailsFrame)

NS_QUERYFRAME_HEAD(DetailsFrame)
  NS_QUERYFRAME_ENTRY(DetailsFrame)
  NS_QUERYFRAME_ENTRY(nsIAnonymousContentCreator)
NS_QUERYFRAME_TAIL_INHERITING(nsBlockFrame)

nsBlockFrame* NS_NewDetailsFrame(PresShell* aPresShell, ComputedStyle* aStyle) {
  return new (aPresShell) DetailsFrame(aStyle, aPresShell->GetPresContext());
}

namespace mozilla {

DetailsFrame::DetailsFrame(ComputedStyle* aStyle, nsPresContext* aPresContext)
    : nsBlockFrame(aStyle, aPresContext, kClassID) {}

DetailsFrame::~DetailsFrame() = default;

void DetailsFrame::SetInitialChildList(ChildListID aListID,
                                       nsFrameList& aChildList) {
#ifdef DEBUG
  if (aListID == kPrincipalList) {
    CheckValidMainSummary(aChildList);
  }
#endif

  nsBlockFrame::SetInitialChildList(aListID, aChildList);
}

#ifdef DEBUG
bool DetailsFrame::CheckValidMainSummary(const nsFrameList& aFrameList) const {
  for (nsIFrame* child : aFrameList) {
    if (child->IsGeneratedContentFrame()) {
      continue;
    }
    HTMLSummaryElement* summary =
        HTMLSummaryElement::FromNode(child->GetContent());
    if (child == aFrameList.FirstChild()) {
      if (summary && summary->IsMainSummary()) {
        return true;
      } else if (child->GetContent() == GetContent()) {
        // The child frame's content is the same as our content, which means
        // it's a kind of wrapper frame. Descend into its child list to find
        // main summary.
        if (CheckValidMainSummary(child->PrincipalChildList())) {
          return true;
        }
      }
    } else {
      NS_ASSERTION(!summary || !summary->IsMainSummary(),
                   "Rest of the children are either not summary element "
                   "or are not the main summary!");
    }
  }
  return false;
}
#endif

void DetailsFrame::DestroyFrom(nsIFrame* aDestructRoot,
                               PostDestroyData& aPostDestroyData) {
  aPostDestroyData.AddAnonymousContent(mDefaultSummary.forget());
  nsBlockFrame::DestroyFrom(aDestructRoot, aPostDestroyData);
}

nsresult DetailsFrame::CreateAnonymousContent(
    nsTArray<ContentInfo>& aElements) {
  auto* details = HTMLDetailsElement::FromNode(GetContent());
  if (details->GetFirstSummary()) {
    return NS_OK;
  }

  // The <details> element lacks any direct <summary> child. Create a default
  // <summary> element as an anonymous content.
  nsNodeInfoManager* nodeInfoManager =
      GetContent()->NodeInfo()->NodeInfoManager();

  RefPtr<NodeInfo> nodeInfo = nodeInfoManager->GetNodeInfo(
      nsGkAtoms::summary, nullptr, kNameSpaceID_XHTML, nsINode::ELEMENT_NODE);
  mDefaultSummary = new (nodeInfoManager) HTMLSummaryElement(nodeInfo.forget());

  nsAutoString defaultSummaryText;
  nsContentUtils::GetMaybeLocalizedString(
      nsContentUtils::eFORMS_PROPERTIES, "DefaultSummary",
      GetContent()->OwnerDoc(), defaultSummaryText);
  RefPtr<nsTextNode> description =
      new (nodeInfoManager) nsTextNode(nodeInfoManager);
  description->SetText(defaultSummaryText, false);
  mDefaultSummary->AppendChildTo(description, false);

  aElements.AppendElement(mDefaultSummary);

  return NS_OK;
}

void DetailsFrame::AppendAnonymousContentTo(nsTArray<nsIContent*>& aElements,
                                            uint32_t aFilter) {
  if (mDefaultSummary) {
    aElements.AppendElement(mDefaultSummary);
  }
}

bool DetailsFrame::HasMainSummaryFrame(nsIFrame* aSummaryFrame) {
  const ChildListIDs flowLists = {kPrincipalList, kOverflowList};
  for (nsIFrame* frag = this; frag; frag = frag->GetNextInFlow()) {
    for (const auto& [list, listID] : frag->ChildLists()) {
      if (!flowLists.contains(listID)) {
        continue;
      }
      for (nsIFrame* child : list) {
        child = nsPlaceholderFrame::GetRealFrameFor(child);
        // We skip any non-primary frames such as a list-style-position:inside
        // bullet frame for the <details> itself.
        if (!child->IsGeneratedContentFrame()) {
          return aSummaryFrame == child;
        }
      }
    }
  }
  return false;
}

}  // namespace mozilla