rippled
ApplyViewBase.cpp
1 //------------------------------------------------------------------------------
2 /*
3  This file is part of rippled: https://github.com/ripple/rippled
4  Copyright (c) 2012, 2013 Ripple Labs Inc.
5 
6  Permission to use, copy, modify, and/or distribute this software for any
7  purpose with or without fee is hereby granted, provided that the above
8  copyright notice and this permission notice appear in all copies.
9 
10  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13  ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 //==============================================================================
19 
20 #include <ripple/basics/contract.h>
21 #include <ripple/ledger/CashDiff.h>
22 #include <ripple/ledger/detail/ApplyViewBase.h>
23 
24 namespace ripple {
25 namespace detail {
26 
28  : flags_(flags), base_(base)
29 {
30 }
31 
32 //---
33 
34 bool
36 {
37  return base_->open();
38 }
39 
40 LedgerInfo const&
42 {
43  return base_->info();
44 }
45 
46 Fees const&
48 {
49  return base_->fees();
50 }
51 
52 Rules const&
54 {
55  return base_->rules();
56 }
57 
58 bool
60 {
61  return items_.exists(*base_, k);
62 }
63 
64 auto
67 {
68  return items_.succ(*base_, key, last);
69 }
70 
72 ApplyViewBase::read(Keylet const& k) const
73 {
74  return items_.read(*base_, k);
75 }
76 
77 auto
78 ApplyViewBase::slesBegin() const -> std::unique_ptr<sles_type::iter_base>
79 {
80  return base_->slesBegin();
81 }
82 
83 auto
84 ApplyViewBase::slesEnd() const -> std::unique_ptr<sles_type::iter_base>
85 {
86  return base_->slesEnd();
87 }
88 
89 auto
92 {
93  return base_->slesUpperBound(key);
94 }
95 
96 auto
97 ApplyViewBase::txsBegin() const -> std::unique_ptr<txs_type::iter_base>
98 {
99  return base_->txsBegin();
100 }
101 
102 auto
103 ApplyViewBase::txsEnd() const -> std::unique_ptr<txs_type::iter_base>
104 {
105  return base_->txsEnd();
106 }
107 
108 bool
110 {
111  return base_->txExists(key);
112 }
113 
114 auto
116 {
117  return base_->txRead(key);
118 }
119 
120 //---
121 
124 {
125  return flags_;
126 }
127 
130 {
131  return items_.peek(*base_, k);
132 }
133 
134 void
136 {
137  items_.erase(*base_, sle);
138 }
139 
140 void
142 {
143  items_.insert(*base_, sle);
144 }
145 
146 void
148 {
149  items_.update(*base_, sle);
150 }
151 
152 //---
153 
154 void
156 {
157  items_.rawErase(*base_, sle);
158 }
159 
160 void
162 {
163  items_.insert(*base_, sle);
164 }
165 
166 void
168 {
169  items_.replace(*base_, sle);
170 }
171 
172 void
174 {
175  items_.destroyXRP(fee);
176 }
177 
178 //---
179 
180 CashDiff
182  CashFilter lhsFilter,
183  ApplyViewBase const& lhs,
184  CashFilter rhsFilter,
185  ApplyViewBase const& rhs)
186 {
187  assert(lhs.base_ == rhs.base_);
188  return CashDiff{*lhs.base_, lhsFilter, lhs.items_, rhsFilter, rhs.items_};
189 }
190 
191 } // namespace detail
192 } // namespace ripple
ripple::ReadView::info
virtual LedgerInfo const & info() const =0
Returns information about the ledger.
ripple::detail::ApplyViewBase::succ
std::optional< key_type > succ(key_type const &key, std::optional< key_type > const &last=std::nullopt) const override
Return the key of the next state item.
Definition: ApplyViewBase.cpp:65
ripple::Keylet
A pair of SHAMap key and LedgerEntryType.
Definition: Keylet.h:38
std::shared_ptr
STL class.
ripple::detail::ApplyViewBase::rawReplace
void rawReplace(std::shared_ptr< SLE > const &sle) override
Unconditionally replace a state item.
Definition: ApplyViewBase.cpp:167
ripple::detail::ApplyViewBase::txsBegin
std::unique_ptr< txs_type::iter_base > txsBegin() const override
Definition: ApplyViewBase.cpp:97
ripple::ReadView::txs_type
Definition: ReadView.h:213
std::pair
ripple::detail::ApplyStateTable::insert
void insert(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:432
ripple::detail::ApplyViewBase::txRead
tx_type txRead(key_type const &key) const override
Read a transaction from the tx map.
Definition: ApplyViewBase.cpp:115
ripple::detail::ApplyViewBase::exists
bool exists(Keylet const &k) const override
Determine if a state item exists.
Definition: ApplyViewBase.cpp:59
ripple::CashDiff
Definition: CashDiff.h:60
ripple::ReadView::fees
virtual Fees const & fees() const =0
Returns the fees for the base ledger.
ripple::ApplyFlags
ApplyFlags
Definition: ApplyView.h:29
ripple::detail::ApplyViewBase::update
void update(std::shared_ptr< SLE > const &sle) override
Indicate changes to a peeked SLE.
Definition: ApplyViewBase.cpp:147
ripple::ReadView::txsEnd
virtual std::unique_ptr< txs_type::iter_base > txsEnd() const =0
ripple::detail::ApplyStateTable::exists
bool exists(ReadView const &base, Keylet const &k) const
Definition: ApplyStateTable.cpp:268
ripple::ReadView::txExists
virtual bool txExists(key_type const &key) const =0
Returns true if a tx exists in the tx map.
ripple::ReadView::slesBegin
virtual std::unique_ptr< sles_type::iter_base > slesBegin() const =0
ripple::detail::ApplyViewBase::fees
Fees const & fees() const override
Returns the fees for the base ledger.
Definition: ApplyViewBase.cpp:47
ripple::detail::ApplyViewBase::items_
detail::ApplyStateTable items_
Definition: ApplyViewBase.h:133
ripple::detail::ApplyStateTable::destroyXRP
void destroyXRP(XRPAmount const &fee)
Definition: ApplyStateTable.cpp:514
ripple::detail::ApplyStateTable::replace
void replace(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:462
ripple::detail::ApplyViewBase::ApplyViewBase
ApplyViewBase()=delete
ripple::ReadView::txsBegin
virtual std::unique_ptr< txs_type::iter_base > txsBegin() const =0
ripple::detail::ApplyViewBase::txsEnd
std::unique_ptr< txs_type::iter_base > txsEnd() const override
Definition: ApplyViewBase.cpp:103
ripple::base_uint< 256 >
ripple::detail::ApplyViewBase::open
bool open() const override
Returns true if this reflects an open ledger.
Definition: ApplyViewBase.cpp:35
ripple::detail::cashFlowDiff
CashDiff cashFlowDiff(CashFilter lhsFilter, ApplyViewBase const &lhs, CashFilter rhsFilter, ApplyViewBase const &rhs)
Definition: ApplyViewBase.cpp:181
ripple::Fees
Reflects the fee settings for a particular ledger.
Definition: ReadView.h:48
ripple::detail::ApplyViewBase::info
LedgerInfo const & info() const override
Returns information about the ledger.
Definition: ApplyViewBase.cpp:41
ripple::detail::ApplyViewBase::slesEnd
std::unique_ptr< sles_type::iter_base > slesEnd() const override
Definition: ApplyViewBase.cpp:84
ripple::detail::ApplyViewBase::base_
ReadView const * base_
Definition: ApplyViewBase.h:132
ripple::ReadView::slesEnd
virtual std::unique_ptr< sles_type::iter_base > slesEnd() const =0
ripple::detail::ApplyStateTable::erase
void erase(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:381
ripple::detail::ApplyViewBase::slesBegin
std::unique_ptr< sles_type::iter_base > slesBegin() const override
Definition: ApplyViewBase.cpp:78
ripple::detail::ApplyViewBase::rawErase
void rawErase(std::shared_ptr< SLE > const &sle) override
Delete an existing state item.
Definition: ApplyViewBase.cpp:155
ripple::detail::ApplyStateTable::read
std::shared_ptr< SLE const > read(ReadView const &base, Keylet const &k) const
Definition: ApplyStateTable.cpp:325
ripple::detail::ApplyStateTable::rawErase
void rawErase(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:405
ripple::detail::ApplyViewBase::insert
void insert(std::shared_ptr< SLE > const &sle) override
Insert a new state SLE.
Definition: ApplyViewBase.cpp:141
ripple::detail::ApplyViewBase::erase
void erase(std::shared_ptr< SLE > const &sle) override
Remove a peeked SLE.
Definition: ApplyViewBase.cpp:135
ripple::detail::ApplyViewBase::flags
ApplyFlags flags() const override
Returns the tx apply flags.
Definition: ApplyViewBase.cpp:123
ripple::ReadView
A view into a ledger.
Definition: ReadView.h:192
ripple
Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.
Definition: RCLCensorshipDetector.h:29
ripple::ReadView::sles_type
Definition: ReadView.h:202
ripple::ReadView::rules
virtual Rules const & rules() const =0
Returns the tx processing rules.
std
STL namespace.
ripple::detail::ApplyStateTable::update
void update(ReadView const &base, std::shared_ptr< SLE > const &sle)
Definition: ApplyStateTable.cpp:491
ripple::Rules
Rules controlling protocol behavior.
Definition: ReadView.h:131
ripple::detail::ApplyViewBase::flags_
ApplyFlags flags_
Definition: ApplyViewBase.h:131
std::optional
ripple::detail::ApplyViewBase::read
std::shared_ptr< SLE const > read(Keylet const &k) const override
Return the state item associated with a key.
Definition: ApplyViewBase.cpp:72
ripple::detail::ApplyViewBase::peek
std::shared_ptr< SLE > peek(Keylet const &k) override
Prepare to modify the SLE associated with key.
Definition: ApplyViewBase.cpp:129
ripple::LedgerInfo
Information about the notional ledger backing the view.
Definition: ReadView.h:84
ripple::detail::ApplyViewBase::rules
Rules const & rules() const override
Returns the tx processing rules.
Definition: ApplyViewBase.cpp:53
ripple::detail::ApplyViewBase::txExists
bool txExists(key_type const &key) const override
Returns true if a tx exists in the tx map.
Definition: ApplyViewBase.cpp:109
ripple::detail::ApplyStateTable::peek
std::shared_ptr< SLE > peek(ReadView const &base, Keylet const &k)
Definition: ApplyStateTable.cpp:347
std::unique_ptr
STL class.
ripple::ReadView::open
virtual bool open() const =0
Returns true if this reflects an open ledger.
ripple::detail::ApplyViewBase
Definition: ApplyViewBase.h:33
ripple::CashFilter
CashFilter
Definition: CashDiff.h:39
ripple::detail::ApplyViewBase::rawInsert
void rawInsert(std::shared_ptr< SLE > const &sle) override
Unconditionally insert a state item.
Definition: ApplyViewBase.cpp:161
ripple::detail::ApplyViewBase::slesUpperBound
std::unique_ptr< sles_type::iter_base > slesUpperBound(uint256 const &key) const override
Definition: ApplyViewBase.cpp:90
ripple::XRPAmount
Definition: XRPAmount.h:46
ripple::detail::ApplyViewBase::rawDestroyXRP
void rawDestroyXRP(XRPAmount const &feeDrops) override
Destroy XRP.
Definition: ApplyViewBase.cpp:173