electron/shell/common/gin_helper/arguments.h
Charles Kerr f36ceae024
chore: migrate base::StringPiece to std::string_view (#40915)
* chore: migrate from base::StringPiece to std::string_view in keyboard_util.cc

* chore: migrate from base::StringPiece to std::string_view in error_thrower.cc

* chore: migrate from base::StringPiece to std::string_view in electron_api_web_contents.cc

* chore: migrate from base::StringPiece to std::string_view in gin_helper/dictionary.h

* chore: migrate from base::StringPiece to std::string_view in electron_api_url_loader.cc

* chore: phase out internal use of base:::StringPiece

`base::StringPiece` is being phased out upstream. Its code has been
removed upstream and it's just a typedef for `std::string_view`.

They haven't removed the typedef yet, so this PR tries to get ahead
of future breakage by migrating "internal" use (i.e. leaving alone the
places where the `base::StringPiece` name is coming from an upstream
method that we override).

Xref: https://bugs.chromium.org/p/chromium/issues/detail?id=691162

Xref: https://chromium-review.googlesource.com/c/chromium/src/+/4294483

Xref: https://docs.google.com/document/d/1d4RnD1uAE2t4iANR0nXy82ASIPGsPuw2mpO6v6T7JKs
2024-01-10 19:00:37 -06:00

53 lines
1.5 KiB
C++

// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE.chromium file.
#ifndef ELECTRON_SHELL_COMMON_GIN_HELPER_ARGUMENTS_H_
#define ELECTRON_SHELL_COMMON_GIN_HELPER_ARGUMENTS_H_
#include <string_view>
#include "gin/arguments.h"
namespace gin_helper {
// Provides additional APIs to the gin::Arguments class.
class Arguments : public gin::Arguments {
public:
// Get the next argument, if conversion to T fails then state is unchanged.
//
// This is difference from gin::Arguments::GetNext which always advances the
// |next_| counter no matter whether the conversion succeeds.
template <typename T>
bool GetNext(T* out) {
v8::Local<v8::Value> val = PeekNext();
if (val.IsEmpty())
return false;
if (!gin::ConvertFromV8(isolate(), val, out))
return false;
Skip();
return true;
}
// Gin always returns true when converting V8 value to boolean, we do not want
// this behavior when parsing parameters.
bool GetNext(bool* out) {
v8::Local<v8::Value> val = PeekNext();
if (val.IsEmpty() || !val->IsBoolean())
return false;
*out = val->BooleanValue(isolate());
Skip();
return true;
}
// Throw error with custom error message.
void ThrowError() const;
void ThrowError(std::string_view message) const;
private:
// MUST NOT ADD ANY DATA MEMBER.
};
} // namespace gin_helper
#endif // ELECTRON_SHELL_COMMON_GIN_HELPER_ARGUMENTS_H_