Move webrtc/{base => rtc_base}
This refactoring takes a careful approach to avoid rushing the change:
* stub headers are left in all the old locations of webrtc/base
* existing GN targets are kept and now just forward to the moved ones
using public_deps.
The only exception to the above is the base_java target and its .java files,
which were moved to webrtc/rtc_base right away since it's not possible
to use public_deps for android_library.
To avoid breaking builds, a temporary Dummy.java file was added to
the new intermediate target in webrtc/rtc_base:base_java as well to avoid
hitting a GN assert in the android_library template.
The above approach should make the transition smooth without breaking
downstream.
A helper script was created (https://codereview.webrtc.org/2879203002/)
and was run like this:
stub-headers.py -s webrtc/base -d webrtc/rtc_base -i 7634
stub-headers.py -s webrtc/base/numerics -d webrtc/rtc_base/numerics -i 7634
Fixed invalid header guards in the following files:
webrtc/base/base64.h
webrtc/base/cryptstring.h
webrtc/base/event.h
webrtc/base/flags.h
webrtc/base/httpbase.h
webrtc/base/httpcommon-inl.h
webrtc/base/httpcommon.h
webrtc/base/httpserver.h
webrtc/base/logsinks.h
webrtc/base/macutils.h
webrtc/base/nattypes.h
webrtc/base/openssladapter.h
webrtc/base/opensslstreamadapter.h
webrtc/base/pathutils.h
webrtc/base/physicalsocketserver.h
webrtc/base/proxyinfo.h
webrtc/base/sigslot.h
webrtc/base/sigslotrepeater.h
webrtc/base/socket.h
webrtc/base/socketaddresspair.h
webrtc/base/socketfactory.h
webrtc/base/stringutils.h
webrtc/base/testbase64.h
webrtc/base/testutils.h
webrtc/base/transformadapter.h
webrtc/base/win32filesystem.h
Added new header guards to:
sslroots.h
testbase64.h
BUG=webrtc:7634
NOTRY=True
NOPRESUBMIT=True
R=kwiberg@webrtc.org
Review-Url: https://codereview.webrtc.org/2877023002 .
Cr-Commit-Position: refs/heads/master@{#18816}
diff --git a/webrtc/base/swap_queue.h b/webrtc/base/swap_queue.h
index acb16b4..7111147 100644
--- a/webrtc/base/swap_queue.h
+++ b/webrtc/base/swap_queue.h
@@ -11,201 +11,9 @@
#ifndef WEBRTC_BASE_SWAP_QUEUE_H_
#define WEBRTC_BASE_SWAP_QUEUE_H_
-#include <algorithm>
-#include <utility>
-#include <vector>
-#include "webrtc/base/checks.h"
-#include "webrtc/base/constructormagic.h"
-#include "webrtc/base/criticalsection.h"
-
-namespace webrtc {
-
-namespace internal {
-
-// (Internal; please don't use outside this file.)
-template <typename T>
-bool NoopSwapQueueItemVerifierFunction(const T&) {
- return true;
-}
-
-} // namespace internal
-
-// Functor to use when supplying a verifier function for the queue.
-template <typename T,
- bool (*QueueItemVerifierFunction)(const T&) =
- internal::NoopSwapQueueItemVerifierFunction>
-class SwapQueueItemVerifier {
- public:
- bool operator()(const T& t) const { return QueueItemVerifierFunction(t); }
-};
-
-// This class is a fixed-size queue. A producer calls Insert() to insert
-// an element of type T at the back of the queue, and a consumer calls
-// Remove() to remove an element from the front of the queue. It's safe
-// for the producer(s) and the consumer(s) to access the queue
-// concurrently, from different threads.
-//
-// To avoid the construction, copying, and destruction of Ts that a naive
-// queue implementation would require, for each "full" T passed from
-// producer to consumer, SwapQueue<T> passes an "empty" T in the other
-// direction (an "empty" T is one that contains nothing of value for the
-// consumer). This bidirectional movement is implemented with swap().
-//
-// // Create queue:
-// Bottle proto(568); // Prepare an empty Bottle. Heap allocates space for
-// // 568 ml.
-// SwapQueue<Bottle> q(N, proto); // Init queue with N copies of proto.
-// // Each copy allocates on the heap.
-// // Producer pseudo-code:
-// Bottle b(568); // Prepare an empty Bottle. Heap allocates space for 568 ml.
-// loop {
-// b.Fill(amount); // Where amount <= 568 ml.
-// q.Insert(&b); // Swap our full Bottle for an empty one from q.
-// }
-//
-// // Consumer pseudo-code:
-// Bottle b(568); // Prepare an empty Bottle. Heap allocates space for 568 ml.
-// loop {
-// q.Remove(&b); // Swap our empty Bottle for the next-in-line full Bottle.
-// Drink(&b);
-// }
-//
-// For a well-behaved Bottle class, there are no allocations in the
-// producer, since it just fills an empty Bottle that's already large
-// enough; no deallocations in the consumer, since it returns each empty
-// Bottle to the queue after having drunk it; and no copies along the
-// way, since the queue uses swap() everywhere to move full Bottles in
-// one direction and empty ones in the other.
-template <typename T, typename QueueItemVerifier = SwapQueueItemVerifier<T>>
-class SwapQueue {
- public:
- // Creates a queue of size size and fills it with default constructed Ts.
- explicit SwapQueue(size_t size) : queue_(size) {
- RTC_DCHECK(VerifyQueueSlots());
- }
-
- // Same as above and accepts an item verification functor.
- SwapQueue(size_t size, const QueueItemVerifier& queue_item_verifier)
- : queue_item_verifier_(queue_item_verifier), queue_(size) {
- RTC_DCHECK(VerifyQueueSlots());
- }
-
- // Creates a queue of size size and fills it with copies of prototype.
- SwapQueue(size_t size, const T& prototype) : queue_(size, prototype) {
- RTC_DCHECK(VerifyQueueSlots());
- }
-
- // Same as above and accepts an item verification functor.
- SwapQueue(size_t size,
- const T& prototype,
- const QueueItemVerifier& queue_item_verifier)
- : queue_item_verifier_(queue_item_verifier), queue_(size, prototype) {
- RTC_DCHECK(VerifyQueueSlots());
- }
-
- // Resets the queue to have zero content wile maintaining the queue size.
- void Clear() {
- rtc::CritScope cs(&crit_queue_);
- next_write_index_ = 0;
- next_read_index_ = 0;
- num_elements_ = 0;
- }
-
- // Inserts a "full" T at the back of the queue by swapping *input with an
- // "empty" T from the queue.
- // Returns true if the item was inserted or false if not (the queue was full).
- // When specified, the T given in *input must pass the ItemVerifier() test.
- // The contents of *input after the call are then also guaranteed to pass the
- // ItemVerifier() test.
- bool Insert(T* input) RTC_WARN_UNUSED_RESULT {
- RTC_DCHECK(input);
-
- rtc::CritScope cs(&crit_queue_);
-
- RTC_DCHECK(queue_item_verifier_(*input));
-
- if (num_elements_ == queue_.size()) {
- return false;
- }
-
- using std::swap;
- swap(*input, queue_[next_write_index_]);
-
- ++next_write_index_;
- if (next_write_index_ == queue_.size()) {
- next_write_index_ = 0;
- }
-
- ++num_elements_;
-
- RTC_DCHECK_LT(next_write_index_, queue_.size());
- RTC_DCHECK_LE(num_elements_, queue_.size());
-
- return true;
- }
-
- // Removes the frontmost "full" T from the queue by swapping it with
- // the "empty" T in *output.
- // Returns true if an item could be removed or false if not (the queue was
- // empty). When specified, The T given in *output must pass the ItemVerifier()
- // test and the contents of *output after the call are then also guaranteed to
- // pass the ItemVerifier() test.
- bool Remove(T* output) RTC_WARN_UNUSED_RESULT {
- RTC_DCHECK(output);
-
- rtc::CritScope cs(&crit_queue_);
-
- RTC_DCHECK(queue_item_verifier_(*output));
-
- if (num_elements_ == 0) {
- return false;
- }
-
- using std::swap;
- swap(*output, queue_[next_read_index_]);
-
- ++next_read_index_;
- if (next_read_index_ == queue_.size()) {
- next_read_index_ = 0;
- }
-
- --num_elements_;
-
- RTC_DCHECK_LT(next_read_index_, queue_.size());
- RTC_DCHECK_LE(num_elements_, queue_.size());
-
- return true;
- }
-
- private:
- // Verify that the queue slots complies with the ItemVerifier test.
- bool VerifyQueueSlots() {
- rtc::CritScope cs(&crit_queue_);
- for (const auto& v : queue_) {
- RTC_DCHECK(queue_item_verifier_(v));
- }
- return true;
- }
-
- rtc::CriticalSection crit_queue_;
-
- // TODO(peah): Change this to use std::function() once we can use C++11 std
- // lib.
- QueueItemVerifier queue_item_verifier_ GUARDED_BY(crit_queue_);
-
- // (next_read_index_ + num_elements_) % queue_.size() =
- // next_write_index_
- size_t next_write_index_ GUARDED_BY(crit_queue_) = 0;
- size_t next_read_index_ GUARDED_BY(crit_queue_) = 0;
- size_t num_elements_ GUARDED_BY(crit_queue_) = 0;
-
- // queue_.size() is constant.
- std::vector<T> queue_ GUARDED_BY(crit_queue_);
-
- RTC_DISALLOW_COPY_AND_ASSIGN(SwapQueue);
-};
-
-} // namespace webrtc
+// This header is deprecated and is just left here temporarily during
+// refactoring. See https://bugs.webrtc.org/7634 for more details.
+#include "webrtc/rtc_base/swap_queue.h"
#endif // WEBRTC_BASE_SWAP_QUEUE_H_