string_field.cc | Explore in Territory

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// https://developers.google.com/protocol-buffers/
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// Author: [email protected] (Kenton Varda)
// Author: [email protected] (Jon Perlow)
//  Based on original Protocol Buffers design by
//  Sanjay Ghemawat, Jeff Dean, and others.

#include "google/protobuf/compiler/java/string_field.h"

#include <cstdint>
#include <map>
#include <string>

#include "google/protobuf/stubs/logging.h"
#include "google/protobuf/stubs/common.h"
#include "google/protobuf/io/printer.h"
#include "google/protobuf/wire_format.h"
#include "google/protobuf/stubs/strutil.h"
#include "google/protobuf/compiler/java/context.h"
#include "google/protobuf/compiler/java/doc_comment.h"
#include "google/protobuf/compiler/java/helpers.h"
#include "google/protobuf/compiler/java/name_resolver.h"

namespace google {
namespace protobuf {
namespace compiler {
namespace java {

WireFormat;
WireFormatLite;

namespace {

void SetPrimitiveVariables(
    const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex,
    const FieldGeneratorInfo* info, ClassNameResolver* name_resolver,
    std::map<std::string, std::string>* variables,
    Context* context) { … }

}  // namespace

// ===================================================================

ImmutableStringFieldGenerator::ImmutableStringFieldGenerator(
    const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex,
    Context* context)
    : … { … }

ImmutableStringFieldGenerator::~ImmutableStringFieldGenerator() { … }

int ImmutableStringFieldGenerator::GetMessageBitIndex() const { … }

int ImmutableStringFieldGenerator::GetBuilderBitIndex() const { … }

int ImmutableStringFieldGenerator::GetNumBitsForMessage() const { … }

int ImmutableStringFieldGenerator::GetNumBitsForBuilder() const { … }

// A note about how strings are handled. This code used to just store a String
// in the Message. This had two issues:
//
//  1. It wouldn't roundtrip byte arrays that were not valid UTF-8 encoded
//     strings, but rather fields that were raw bytes incorrectly marked
//     as strings in the proto file. This is common because in the proto1
//     syntax, string was the way to indicate bytes and C++ engineers can
//     easily make this mistake without affecting the C++ API. By converting to
//     strings immediately, some java code might corrupt these byte arrays as
//     it passes through a java server even if the field was never accessed by
//     application code.
//
//  2. There's a performance hit to converting between bytes and strings and
//     it many cases, the field is never even read by the application code. This
//     avoids unnecessary conversions in the common use cases.
//
// So now, the field for String is maintained as an Object reference which can
// either store a String or a ByteString. The code uses an instanceof check
// to see which one it has and converts to the other one if needed. It remembers
// the last value requested (in a thread safe manner) as this is most likely
// the one needed next. The thread safety is such that if two threads both
// convert the field because the changes made by each thread were not visible to
// the other, they may cause a conversion to happen more times than would
// otherwise be necessary. This was deemed better than adding synchronization
// overhead. It will not cause any corruption issues or affect the behavior of
// the API. The instanceof check is also highly optimized in the JVM and we
// decided it was better to reduce the memory overhead by not having two
// separate fields but rather use dynamic type checking.
//
// For single fields, the logic for this is done inside the generated code. For
// repeated fields, the logic is done in LazyStringArrayList and
// UnmodifiableLazyStringList.
void ImmutableStringFieldGenerator::GenerateInterfaceMembers(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateMembers(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateBuilderMembers(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateKotlinDslMembers(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateFieldBuilderInitializationCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateInitializationCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateBuilderClearCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateMergingCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateBuildingCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateBuilderParsingCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateSerializationCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateSerializedSizeCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateEqualsCode(
    io::Printer* printer) const { … }

void ImmutableStringFieldGenerator::GenerateHashCode(
    io::Printer* printer) const { … }

std::string ImmutableStringFieldGenerator::GetBoxedType() const { … }

// ===================================================================

ImmutableStringOneofFieldGenerator::ImmutableStringOneofFieldGenerator(
    const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex,
    Context* context)
    : … { … }

ImmutableStringOneofFieldGenerator::~ImmutableStringOneofFieldGenerator() { … }

void ImmutableStringOneofFieldGenerator::GenerateMembers(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateBuilderMembers(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateBuilderClearCode(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateMergingCode(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateBuildingCode(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateBuilderParsingCode(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateSerializationCode(
    io::Printer* printer) const { … }

void ImmutableStringOneofFieldGenerator::GenerateSerializedSizeCode(
    io::Printer* printer) const { … }

// ===================================================================

RepeatedImmutableStringFieldGenerator::RepeatedImmutableStringFieldGenerator(
    const FieldDescriptor* descriptor, int messageBitIndex, int builderBitIndex,
    Context* context)
    : … { … }

RepeatedImmutableStringFieldGenerator::
    ~RepeatedImmutableStringFieldGenerator() { … }

int RepeatedImmutableStringFieldGenerator::GetNumBitsForMessage() const { … }

int RepeatedImmutableStringFieldGenerator::GetNumBitsForBuilder() const { … }

void RepeatedImmutableStringFieldGenerator::GenerateInterfaceMembers(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateMembers(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateBuilderMembers(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateKotlinDslMembers(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::
    GenerateFieldBuilderInitializationCode(io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateInitializationCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateBuilderClearCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateMergingCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateBuildingCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateBuilderParsingCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateSerializationCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateSerializedSizeCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateEqualsCode(
    io::Printer* printer) const { … }

void RepeatedImmutableStringFieldGenerator::GenerateHashCode(
    io::Printer* printer) const { … }

std::string RepeatedImmutableStringFieldGenerator::GetBoxedType() const { … }

}  // namespace java
}  // namespace compiler
}  // namespace protobuf
}  // namespace google
chromium/third_party/protobuf/src/google/protobuf/compiler/java/string_field.cc
