File: plugin_protos.py

package info (click to toggle)
chromium 138.0.7204.183-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 6,071,908 kB
  • sloc: cpp: 34,937,088; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,953; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,806; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (292 lines) | stat: -rw-r--r-- 8,378 bytes parent folder | download | duplicates (10)
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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# Copyright 2016 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

"""
Provides simple state-less wrappers of the proto types used by plugins.

See https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.descriptor.pb
and https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.compiler.plugin.pb
"""

import os
import sys

SCRIPT_DIR = os.path.dirname(__file__)
SRC_DIR = os.path.abspath(os.path.join(SCRIPT_DIR, '..', '..', '..', '..'))

sys.path.insert(
    1, os.path.join(SRC_DIR, 'third_party', 'protobuf', 'python'))
sys.path.insert(
    1, os.path.join(SRC_DIR, 'third_party', 'protobuf', 'third_party', 'six'))
from google.protobuf.descriptor_pb2 import FieldDescriptorProto
from google.protobuf.compiler import plugin_pb2

from . import types


class PluginRequest(object):
  def __init__(self, proto):
    self.proto = proto

  def GetArgs(self):
    return dict((v.split('=') for v in self.proto.parameter.split(',')))

  def GetAllFiles(self):
    files = [ProtoFile(x) for x in self.proto.proto_file]
    for f in files:
      assert f.Filename() in self.proto.file_to_generate
    return files


def PluginRequestFromString(data):
  request_proto = plugin_pb2.CodeGeneratorRequest()
  request_proto.ParseFromString(data)
  return PluginRequest(request_proto)


class PluginResponse(object):
  def __init__(self):
    self.proto = plugin_pb2.CodeGeneratorResponse()

  def AddFileWithContent(self, filename, content):
    file_proto = self.proto.file.add()
    file_proto.name = filename
    file_proto.content = content

  def AddError(self, err):
    self.proto.error += err + '\n'

  def WriteToStdout(self):
    stream = sys.stdout if sys.version_info[0] < 3 else sys.stdout.buffer
    stream.write(self.proto.SerializeToString())
    stream.flush()


class ProtoFile(object):
  def __init__(self, proto):
    self.proto = proto
    self.qualified_types = types.QualifiedTypes(
        self.ProtoPackage(),
        self.JavaPackage() + '.' + self.JavaOuterClass(),
        self.CppBaseNamespace(),
        self.CppConverterNamespace()
    )

  def Filename(self):
    return self.proto.name

  def CheckSupported(self):
    if self.proto.service:
      return 'Services are not supported'

    if self.proto.extension:
      return 'Extensions are not supported'

    for child in self.GetMessages() + self.GetEnums():
      err = child.CheckSupported()
      if err:
        return err

  def ProtoPackage(self):
    return self.proto.package if self.proto.HasField('package') else ''

  def ProtoNamespaces(self):
    return self.ProtoPackage().split('.')

  def CppBaseNamespace(self):
    return '::'.join(self.ProtoNamespaces())

  def CppBaseHeader(self):
    assert self.proto.name.endswith('.proto')
    return self.proto.name[:-5] + 'pb.h'

  def CppConverterNamespace(self):
    return self.CppBaseNamespace() + '::json'

  def JavaPackage(self):
    if self.proto.options.HasField('java_package'):
      return self.proto.options.java_package
    else:
      return self.ProtoPackage()

  def GetMessages(self):
    return [ProtoMessage(n, self.qualified_types)
            for n in self.proto.message_type]

  def GetEnums(self):
    return [ProtoEnum(n, self.qualified_types) for n in self.proto.enum_type]

  def GetDependencies(self):
    # import is not supported
    assert [] == self.proto.dependency
    return [types.GetProtoFileForFilename(x) for x in self.proto.dependency]

  def JavaFilename(self):
    return '/'.join(self.JavaQualifiedOuterClass().split('.')) + '.java'

  def JavaOuterClass(self):
    if self.proto.options.HasField('java_outer_classname'):
      return self.proto.options.java_outer_classname
    basename, _ = os.path.splitext(os.path.basename(self.proto.name))
    return types.TitleCase(basename)

  def JavaQualifiedOuterClass(self):
    return self.qualified_types.java

  def CppConverterFilename(self):
    assert self.proto.name.endswith('.proto')
    return self.proto.name[:-6] + '_json_converter.h'


class ProtoMessage(object):
  def __init__(self, proto, parent_typenames):
    self.proto = proto
    self.qualified_types = types.QualifiedTypesForChild(
        proto.name, parent_typenames)

  def CheckSupported(self):
    if self.proto.extension_range:
      return 'Extensions are not supported: ' + self.proto.extension_range

    for child in self.GetFields() + self.GetMessages() + self.GetEnums():
      err = child.CheckSupported()
      if err:
        return err

  def QualifiedTypes(self):
    return self.qualified_types

  def JavaClassName(self):
    return types.TitleCase(self.proto.name)

  def CppConverterClassName(self):
    return types.TitleCase(self.proto.name)

  def GetFields(self):
    return [ProtoField(x) for x in self.proto.field]

  def GetMessages(self):
    return [ProtoMessage(n, self.qualified_types)
            for n in self.proto.nested_type]

  def GetEnums(self):
    return [ProtoEnum(n, self.qualified_types) for n in self.proto.enum_type]


class ProtoField(object):
  def __init__(self, field_proto):
    self.proto = field_proto
    self.name = field_proto.name

    if self.IsClassType() and not self.proto.HasField('type_name'):
      raise TypeError('expected type_name')

  def Extendee(self):
    return self.proto.extendee if self.proto.HasField('extendee') else None

  def IsOptional(self):
    return self.proto.label == FieldDescriptorProto.LABEL_OPTIONAL

  def IsRepeated(self):
    return self.proto.label == FieldDescriptorProto.LABEL_REPEATED

  def IsRequired(self):
    return self.proto.label == FieldDescriptorProto.LABEL_REQUIRED

  def IsClassType(self):
    return self.proto.type == FieldDescriptorProto.TYPE_MESSAGE

  def IsEnumType(self):
    return self.proto.type == FieldDescriptorProto.TYPE_ENUM

  def JavaType(self):
    if self.IsClassType():
      return types.ResolveJavaClassType(self.proto.type_name)
    elif self.IsEnumType():
      return 'int'
    else:
      return types.GetJavaPrimitiveType(self.proto.type)

  def JavaListType(self):
    return types.GetJavaObjectType(self.JavaType())

  def JavascriptIndex(self):
    return self.proto.number

  def JavaName(self):
    return types.TitleCase(self.name)

  def CppConverterType(self):
    return types.ResolveCppConverterType(self.proto.type_name)

  def CppPrimitiveType(self):
    assert not self.IsClassType()
    return types.GetCppPrimitiveType(self.proto.type)

  def CppValueType(self):
    return types.GetCppValueType(self.CppPrimitiveType())

  def CppValuePredicate(self, variable_name):
    return types.GetCppValuePredicate(self.CppPrimitiveType(), variable_name)

  def CheckSupported(self):
    if self.Extendee():
      return 'Unsupported field extension: ' + self.DebugString()

    if self.JavaType() is None:
      return 'Unsupported type for field: ' + self.DebugString()

    if self.IsRequired():
      return 'Required fields not supported: ' + self.DebugString()

    if self.proto.HasField('default_value'):
      return 'Default values are not supported: ' + self.DebugString()

    return None

  def DebugString(self):
    return '{name}, {type}, {extendee}'.format(
        name=self.name,
        type=self.proto.type,
        extendee=self.Extendee())


class ProtoEnum(object):
  def __init__(self, proto, parent_typenames):
    self.proto = proto
    self.qualified_types = types.QualifiedTypesForChild(
        proto.name, parent_typenames)

  def CheckSupported(self):
    if self.proto.HasField('options'):
      return 'Enum options are not supported: ' + self.DebugString()
    for val in self.Values():
      err = val.CheckSupported()
      if err:
        return err + ' ' + self.DebugString()

  def QualifiedTypes(self):
    return self.qualified_types

  def JavaName(self):
    return types.TitleCase(self.proto.name)

  def Values(self):
    return [ProtoEnumValue(x) for x in self.proto.value]


class ProtoEnumValue(object):
  def __init__(self, enum_value_proto):
    self.proto = enum_value_proto

  def GetName(self):
    return self.proto.name

  def GetValue(self):
    return self.proto.number

  def CheckSupported(self):
    if self.proto.HasField('options'):
      return 'Enum value options are not supported: {} {}'.format(
          self.proto.name, self.proto.value)