package BERTBuffers

Get desktop application:
View/edit binary Protocol Buffers messages

* array/list/matrix/frame type

Used in: Variable

• int32 rows = 1

• int32 cols = 2

• repeated Variable data = 3

• repeated string rownames = 4

• repeated string colnames = 5

* unifying call and response, since there are some fuzzy cases, callbacks, and so on. it makes sense for this to be a single message with a switch. FIXME: let's revert "callback" to a separate field for clarity, even though it has the same type as function_call; we have space. FIXME: we now have two errors -- one in here (top level) and one in variable (via result). is that useful? it certainly is confusing. I suppose it distinguishes between errors in the function call and results that are errors...

• uint32 id = 1

• bool wait = 2

  FIXME: this can go? should we always require full transactions?

• oneof operation

  • string err = 3

    FIXME: use error type? [yes, work towards that]

  • Variable result = 4

  • Console console = 5

    console maybe should be a separate root message, it doesn't need a response

  • Code code = 6

  • string shell_command = 7

  • CompositeFunctionCall function_call = 8

  • FunctionList function_list = 9

    can we just include a "repeated" element as a union member? [A: no]

  • uint32 user_command = 10

Used in: CompositeFunctionCall

• language = 0

• COM = 1

• system = 2

• graphics = 3

* distinction between calls and accessors (and accesor type)

Used in: CompositeFunctionCall, FunctionDescriptor

• method = 0

• get = 1

• put = 2

* why not have a single string and then split on the RX side?

Used in: CallResponse

• repeated string line = 1

• bool startup = 2

* although colors are passed as 4x 32-bit, they're actually only 8 bits each. FIXME: who passes colors as 128 bits? that's not a thing.

Used in: GraphicsContext

• uint32 a = 1

• uint32 r = 2

• uint32 g = 3

• uint32 b = 4

* complex numbers

Used in: Variable

• double r = 1

• double i = 2

* consolidating function call, callback, COM function call, and control/system calls with arguments

Used in: CallResponse

• string function = 1

• repeated Variable arguments = 2

• uint64 pointer = 3

• uint32 index = 4

• CallType type = 5

• CallTarget target = 6

• uint32 flags = 7

* console message

Used in: CallResponse

• oneof message

  • string text = 1

  • string err = 2

  • string prompt = 3

  • GraphicsCommand graphics = 4

  • MIMEData mime_data = 5

  • Variable history = 6

Used in: ExternalPointer

• string name = 1

• repeated EnumValue values = 2

* for COM enums

Used in: EnumType

• string name = 1

• int32 value = 2

* error has a type and/or message

Used in: Variable

• ErrorType type = 1

• string message = 2

* error types

Used in: Error

• GENERIC = 0

• NA = 1

• INF = 2

• PARSE = 3

• EXECUTION = 4

• OTHER = 15

* now we're getting less and less general. not sure that's a good thing.

Used in: Variable

• string interface_name = 1

  d'oh (don't use the name "interface")

• uint64 pointer = 2

• repeated FunctionDescriptor functions = 3

  FunctionList functions = 3;

• repeated EnumType enums = 4

* this type describes a function. adding type so we can reuse this for COM

Used in: ExternalPointer, FunctionList

• optional FunctionElement function = 1

• CallType call_type = 2

• uint32 flags = 3

• string category = 4

• repeated FunctionElement arguments = 5

* to date, we've been constructing function descriptions by packing them in normal variables. for R, we can use the "name" attribute to identify them. that's not available in Julia (and wouldn't be in some other languages either). this results in inconsitent data arriving at Excel, which requires language-specific handling. in an effort to normalize this data, and recognizing that this message scheme is application-specific, we'll define specific types for function descriptors (AND com calls, below). this type can be used for both the function itself and arguments.

Used in: FunctionDescriptor

• string name = 1

• string type_name = 2

  not used atm

• optional Variable default_value = 3

• string description = 4

• uint32 index = 5

  added for COM

* list of functions. union type can't include arrays, so we need an array.

Used in: CallResponse

• repeated FunctionDescriptor functions = 1

* we're now adding graphics to support a console graphics device in R. might extend to julia, although that will probably be based on GR and so a little simpler. packing in a variety of different parameters here, this may need to get streamlined... we can also do some creative reuse.

Used in: Console

• string command = 1

• repeated double x = 2

• repeated double y = 3

• double r = 4

• double rot = 5

• string text = 6

• bool filled = 7

  flag -- should go in context?

• double hadj = 8

• bytes raster = 9

• bool interpolate = 10

  flag

• string device_type = 14

  device type

• optional GraphicsContext context = 15

Used in: GraphicsCommand

• optional Color col = 1

• optional Color fill = 2

• double gamma = 3

• double lwd = 4

• int32 lty = 5

• int32 lend = 6

• int32 ljoin = 7

  this is a three-value enum (actually defines, but only 3 states)

• double lmitre = 8

  also a three-value enum

• double cex = 9

• double ps = 10

• double lineheight = 11

• int32 fontface = 12

  this is another set of flags

• string fontfamily = 13

Used in: Variable

• GraphicsUpdateCommand command = 1

• string name = 2

• string path = 3

• uint32 width = 4

• uint32 height = 5

Used in: GraphicsUpdate

• update = 0

• query_size = 1

Used in: Console

• string mime_type = 1

• bytes data = 2

* sheet reference

Used in: Variable

• uint32 start_row = 1

• uint32 start_column = 2

• uint32 end_row = 3

• uint32 end_column = 4

• uint64 sheet_id = 5

* basic variable type, optionally named

Used in: Array, CallResponse, CompositeFunctionCall, Console, FunctionElement

• oneof value

  • bool nil = 1

  • bool missing = 2

  • Error err = 3

  • int32 integer = 5

  • double real = 6

  • string str = 7

  • bool boolean = 8

  • Complex cpx = 9

  • Array arr = 10

  • SheetReference ref = 11

  • ExternalPointer com_pointer = 12

    taking over, maybe drop the other one

  • GraphicsUpdate graphics = 13

  • uint32 cache_reference = 14

• string name = 15