mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-20 00:51:42 +00:00
[wpiutil, ntcore] Add structured data support (#5391)
This adds support for two serialization formats for complex data types: - Protobuf for complex objects with variable length internals that need forward and backward wire compatibility (lower speed, more flexible) - Raw struct (ByteBuffer-style) for fixed-length objects (higher speed, less flexible) Deserialization can be done either by creating a new object (for immutable objects) or overwriting the contents of an existing object (for mutable objects). Implementing classes should provide inner classes that implement the Protobuf or Struct interface (in Java) or specialize the wpi::Protobuf or wpi::Struct struct (in C++). It is possible for classes to implement both. If the class itself does not implement serialization, it's possible for third parties/users to provide an implementation instead. Uses the Google protobuf implementation for C++ and the QuickBuffers alternative protobuf implementation for Java.
This commit is contained in:
@@ -4,7 +4,14 @@
|
||||
|
||||
package edu.wpi.first.util.datalog;
|
||||
|
||||
import edu.wpi.first.util.WPIUtilJNI;
|
||||
import edu.wpi.first.util.protobuf.Protobuf;
|
||||
import edu.wpi.first.util.struct.Struct;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.util.HashSet;
|
||||
import java.util.Set;
|
||||
import java.util.concurrent.ConcurrentHashMap;
|
||||
import java.util.concurrent.ConcurrentMap;
|
||||
|
||||
/**
|
||||
* A data log. The log file is created immediately upon construction with a temporary filename. The
|
||||
@@ -104,6 +111,130 @@ public final class DataLog implements AutoCloseable {
|
||||
DataLogJNI.resume(m_impl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether there is a data schema already registered with the given name.
|
||||
*
|
||||
* @param name Name (the string passed as the data type for records using this schema)
|
||||
* @return True if schema already registered
|
||||
*/
|
||||
public boolean hasSchema(String name) {
|
||||
return m_schemaSet.contains(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a data schema. Data schemas provide information for how a certain data type string
|
||||
* can be decoded. The type string of a data schema indicates the type of the schema itself (e.g.
|
||||
* "protobuf" for protobuf schemas, "struct" for struct schemas, etc). In the data log, schemas
|
||||
* are saved just like normal records, with the name being generated from the provided name:
|
||||
* "/.schema/name". Duplicate calls to this function with the same name are silently ignored.
|
||||
*
|
||||
* @param name Name (the string passed as the data type for records using this schema)
|
||||
* @param type Type of schema (e.g. "protobuf", "struct", etc)
|
||||
* @param schema Schema data
|
||||
* @param timestamp Time stamp (may be 0 to indicate now)
|
||||
*/
|
||||
public void addSchema(String name, String type, byte[] schema, long timestamp) {
|
||||
if (!m_schemaSet.add(name)) {
|
||||
return;
|
||||
}
|
||||
DataLogJNI.addSchema(m_impl, name, type, schema, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a data schema. Data schemas provide information for how a certain data type string
|
||||
* can be decoded. The type string of a data schema indicates the type of the schema itself (e.g.
|
||||
* "protobuf" for protobuf schemas, "struct" for struct schemas, etc). In the data log, schemas
|
||||
* are saved just like normal records, with the name being generated from the provided name:
|
||||
* "/.schema/name". Duplicate calls to this function with the same name are silently ignored.
|
||||
*
|
||||
* @param name Name (the string passed as the data type for records using this schema)
|
||||
* @param type Type of schema (e.g. "protobuf", "struct", etc)
|
||||
* @param schema Schema data
|
||||
*/
|
||||
public void addSchema(String name, String type, byte[] schema) {
|
||||
addSchema(name, type, schema, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a data schema. Data schemas provide information for how a certain data type string
|
||||
* can be decoded. The type string of a data schema indicates the type of the schema itself (e.g.
|
||||
* "protobuf" for protobuf schemas, "struct" for struct schemas, etc). In the data log, schemas
|
||||
* are saved just like normal records, with the name being generated from the provided name:
|
||||
* "/.schema/name". Duplicate calls to this function with the same name are silently ignored.
|
||||
*
|
||||
* @param name Name (the string passed as the data type for records using this schema)
|
||||
* @param type Type of schema (e.g. "protobuf", "struct", etc)
|
||||
* @param schema Schema data
|
||||
* @param timestamp Time stamp (may be 0 to indicate now)
|
||||
*/
|
||||
public void addSchema(String name, String type, String schema, long timestamp) {
|
||||
if (!m_schemaSet.add(name)) {
|
||||
return;
|
||||
}
|
||||
DataLogJNI.addSchemaString(m_impl, name, type, schema, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a data schema. Data schemas provide information for how a certain data type string
|
||||
* can be decoded. The type string of a data schema indicates the type of the schema itself (e.g.
|
||||
* "protobuf" for protobuf schemas, "struct" for struct schemas, etc). In the data log, schemas
|
||||
* are saved just like normal records, with the name being generated from the provided name:
|
||||
* "/.schema/name". Duplicate calls to this function with the same name are silently ignored.
|
||||
*
|
||||
* @param name Name (the string passed as the data type for records using this schema)
|
||||
* @param type Type of schema (e.g. "protobuf", "struct", etc)
|
||||
* @param schema Schema data
|
||||
*/
|
||||
public void addSchema(String name, String type, String schema) {
|
||||
addSchema(name, type, schema, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a protobuf schema. Duplicate calls to this function with the same name are silently
|
||||
* ignored.
|
||||
*
|
||||
* @param proto protobuf serialization object
|
||||
* @param timestamp Time stamp (0 to indicate now)
|
||||
*/
|
||||
public void addSchema(Protobuf<?, ?> proto, long timestamp) {
|
||||
final long actualTimestamp = timestamp == 0 ? WPIUtilJNI.now() : timestamp;
|
||||
proto.forEachDescriptor(
|
||||
this::hasSchema,
|
||||
(typeString, schema) ->
|
||||
addSchema(typeString, "proto:FileDescriptorProto", schema, actualTimestamp));
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a protobuf schema. Duplicate calls to this function with the same name are silently
|
||||
* ignored.
|
||||
*
|
||||
* @param proto protobuf serialization object
|
||||
*/
|
||||
public void addSchema(Protobuf<?, ?> proto) {
|
||||
addSchema(proto, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a struct schema. Duplicate calls to this function with the same name are silently
|
||||
* ignored.
|
||||
*
|
||||
* @param struct struct serialization object
|
||||
* @param timestamp Time stamp (0 to indicate now)
|
||||
*/
|
||||
public void addSchema(Struct<?> struct, long timestamp) {
|
||||
addSchemaImpl(struct, timestamp == 0 ? WPIUtilJNI.now() : timestamp, new HashSet<>());
|
||||
}
|
||||
|
||||
/**
|
||||
* Registers a struct schema. Duplicate calls to this function with the same name are silently
|
||||
* ignored.
|
||||
*
|
||||
* @param struct struct serialization object
|
||||
*/
|
||||
public void addSchema(Struct<?> struct) {
|
||||
addSchema(struct, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Start an entry. Duplicate names are allowed (with the same type), and result in the same index
|
||||
* being returned (start/finish are reference counted). A duplicate name with a different type
|
||||
@@ -358,5 +489,22 @@ public final class DataLog implements AutoCloseable {
|
||||
return m_impl;
|
||||
}
|
||||
|
||||
private void addSchemaImpl(Struct<?> struct, long timestamp, Set<String> seen) {
|
||||
String typeString = struct.getTypeString();
|
||||
if (hasSchema(typeString)) {
|
||||
return;
|
||||
}
|
||||
if (!seen.add(typeString)) {
|
||||
throw new UnsupportedOperationException(typeString + ": circular reference with " + seen);
|
||||
}
|
||||
addSchema(typeString, "structschema", struct.getSchema(), timestamp);
|
||||
for (Struct<?> inner : struct.getNested()) {
|
||||
addSchemaImpl(inner, timestamp, seen);
|
||||
}
|
||||
seen.remove(typeString);
|
||||
}
|
||||
|
||||
private long m_impl;
|
||||
private final ConcurrentMap<String, Integer> m_schemaMap = new ConcurrentHashMap<>();
|
||||
private final Set<String> m_schemaSet = m_schemaMap.keySet();
|
||||
}
|
||||
|
||||
@@ -18,6 +18,11 @@ public class DataLogJNI extends WPIUtilJNI {
|
||||
|
||||
static native void resume(long impl);
|
||||
|
||||
static native void addSchema(long impl, String name, String type, byte[] schema, long timestamp);
|
||||
|
||||
static native void addSchemaString(
|
||||
long impl, String name, String type, String schema, long timestamp);
|
||||
|
||||
static native int start(long impl, String name, String type, String metadata, long timestamp);
|
||||
|
||||
static native void finish(long impl, int entry, long timestamp);
|
||||
|
||||
@@ -0,0 +1,117 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.datalog;
|
||||
|
||||
import edu.wpi.first.util.protobuf.Protobuf;
|
||||
import edu.wpi.first.util.protobuf.ProtobufBuffer;
|
||||
import java.io.IOException;
|
||||
import java.nio.ByteBuffer;
|
||||
import us.hebi.quickbuf.ProtoMessage;
|
||||
|
||||
/**
|
||||
* Log protobuf-encoded values.
|
||||
*
|
||||
* @param <T> value class
|
||||
*/
|
||||
public final class ProtobufLogEntry<T> extends DataLogEntry {
|
||||
private ProtobufLogEntry(
|
||||
DataLog log, String name, Protobuf<T, ?> proto, String metadata, long timestamp) {
|
||||
super(log, name, proto.getTypeString(), metadata, timestamp);
|
||||
m_buf = ProtobufBuffer.create(proto);
|
||||
log.addSchema(proto, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a protobuf-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from proto)
|
||||
* @param <MessageType> protobuf message type (inferred from proto)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param proto protobuf serialization implementation
|
||||
* @param metadata metadata
|
||||
* @param timestamp entry creation timestamp (0=now)
|
||||
* @return ProtobufLogEntry
|
||||
*/
|
||||
public static <T, MessageType extends ProtoMessage<?>> ProtobufLogEntry<T> create(
|
||||
DataLog log, String name, Protobuf<T, MessageType> proto, String metadata, long timestamp) {
|
||||
return new ProtobufLogEntry<T>(log, name, proto, metadata, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a protobuf-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from proto)
|
||||
* @param <MessageType> protobuf message type (inferred from proto)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param proto protobuf serialization implementation
|
||||
* @param metadata metadata
|
||||
* @return ProtobufLogEntry
|
||||
*/
|
||||
public static <T, MessageType extends ProtoMessage<?>> ProtobufLogEntry<T> create(
|
||||
DataLog log, String name, Protobuf<T, MessageType> proto, String metadata) {
|
||||
return create(log, name, proto, metadata, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a protobuf-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from proto)
|
||||
* @param <MessageType> protobuf message type (inferred from proto)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param proto protobuf serialization implementation
|
||||
* @param timestamp entry creation timestamp (0=now)
|
||||
* @return ProtobufLogEntry
|
||||
*/
|
||||
public static <T, MessageType extends ProtoMessage<?>> ProtobufLogEntry<T> create(
|
||||
DataLog log, String name, Protobuf<T, MessageType> proto, long timestamp) {
|
||||
return create(log, name, proto, "", timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a protobuf-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from proto)
|
||||
* @param <MessageType> protobuf message type (inferred from proto)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param proto protobuf serialization implementation
|
||||
* @return ProtobufLogEntry
|
||||
*/
|
||||
public static <T, MessageType extends ProtoMessage<?>> ProtobufLogEntry<T> create(
|
||||
DataLog log, String name, Protobuf<T, MessageType> proto) {
|
||||
return create(log, name, proto, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
* @param timestamp Time stamp (0 to indicate now)
|
||||
*/
|
||||
public void append(T value, long timestamp) {
|
||||
try {
|
||||
synchronized (m_buf) {
|
||||
ByteBuffer bb = m_buf.write(value);
|
||||
m_log.appendRaw(m_entry, bb, 0, bb.position(), timestamp);
|
||||
}
|
||||
} catch (IOException e) {
|
||||
// ignore
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
*/
|
||||
public void append(T value) {
|
||||
append(value, 0);
|
||||
}
|
||||
|
||||
private final ProtobufBuffer<T, ?> m_buf;
|
||||
}
|
||||
@@ -0,0 +1,140 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.datalog;
|
||||
|
||||
import edu.wpi.first.util.struct.Struct;
|
||||
import edu.wpi.first.util.struct.StructBuffer;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.util.Collection;
|
||||
|
||||
/**
|
||||
* Log struct-encoded array values.
|
||||
*
|
||||
* @param <T> value class
|
||||
*/
|
||||
public final class StructArrayLogEntry<T> extends DataLogEntry {
|
||||
private StructArrayLogEntry(
|
||||
DataLog log, String name, Struct<T> struct, String metadata, long timestamp) {
|
||||
super(log, name, struct.getTypeString() + "[]", metadata, timestamp);
|
||||
m_buf = StructBuffer.create(struct);
|
||||
log.addSchema(struct, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded array log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @param metadata metadata
|
||||
* @param timestamp entry creation timestamp (0=now)
|
||||
* @return StructArrayLogEntry
|
||||
*/
|
||||
public static <T> StructArrayLogEntry<T> create(
|
||||
DataLog log, String name, Struct<T> struct, String metadata, long timestamp) {
|
||||
return new StructArrayLogEntry<T>(log, name, struct, metadata, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded array log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @param metadata metadata
|
||||
* @return StructArrayLogEntry
|
||||
*/
|
||||
public static <T> StructArrayLogEntry<T> create(
|
||||
DataLog log, String name, Struct<T> struct, String metadata) {
|
||||
return create(log, name, struct, metadata, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded array log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @param timestamp entry creation timestamp (0=now)
|
||||
* @return StructArrayLogEntry
|
||||
*/
|
||||
public static <T> StructArrayLogEntry<T> create(
|
||||
DataLog log, String name, Struct<T> struct, long timestamp) {
|
||||
return create(log, name, struct, "", timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded array log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @return StructArrayLogEntry
|
||||
*/
|
||||
public static <T> StructArrayLogEntry<T> create(DataLog log, String name, Struct<T> struct) {
|
||||
return create(log, name, struct, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures sufficient buffer space is available for the given number of elements.
|
||||
*
|
||||
* @param nelem number of elements
|
||||
*/
|
||||
public void reserve(int nelem) {
|
||||
synchronized (m_buf) {
|
||||
m_buf.reserve(nelem);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
* @param timestamp Time stamp (0 to indicate now)
|
||||
*/
|
||||
public void append(T[] value, long timestamp) {
|
||||
synchronized (this) {
|
||||
ByteBuffer bb = m_buf.writeArray(value);
|
||||
m_log.appendRaw(m_entry, bb, 0, bb.position(), timestamp);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
*/
|
||||
public void append(T[] value) {
|
||||
append(value, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
* @param timestamp Time stamp (0 to indicate now)
|
||||
*/
|
||||
public void append(Collection<T> value, long timestamp) {
|
||||
synchronized (m_buf) {
|
||||
ByteBuffer bb = m_buf.writeArray(value);
|
||||
m_log.appendRaw(m_entry, bb, 0, bb.position(), timestamp);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
*/
|
||||
public void append(Collection<T> value) {
|
||||
append(value, 0);
|
||||
}
|
||||
|
||||
private final StructBuffer<T> m_buf;
|
||||
}
|
||||
@@ -0,0 +1,106 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.datalog;
|
||||
|
||||
import edu.wpi.first.util.struct.Struct;
|
||||
import edu.wpi.first.util.struct.StructBuffer;
|
||||
import java.nio.ByteBuffer;
|
||||
|
||||
/**
|
||||
* Log struct-encoded values.
|
||||
*
|
||||
* @param <T> value class
|
||||
*/
|
||||
public final class StructLogEntry<T> extends DataLogEntry {
|
||||
private StructLogEntry(
|
||||
DataLog log, String name, Struct<T> struct, String metadata, long timestamp) {
|
||||
super(log, name, struct.getTypeString(), metadata, timestamp);
|
||||
m_buf = StructBuffer.create(struct);
|
||||
log.addSchema(struct, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @param metadata metadata
|
||||
* @param timestamp entry creation timestamp (0=now)
|
||||
* @return StructLogEntry
|
||||
*/
|
||||
public static <T> StructLogEntry<T> create(
|
||||
DataLog log, String name, Struct<T> struct, String metadata, long timestamp) {
|
||||
return new StructLogEntry<T>(log, name, struct, metadata, timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @param metadata metadata
|
||||
* @return StructLogEntry
|
||||
*/
|
||||
public static <T> StructLogEntry<T> create(
|
||||
DataLog log, String name, Struct<T> struct, String metadata) {
|
||||
return create(log, name, struct, metadata, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @param timestamp entry creation timestamp (0=now)
|
||||
* @return StructLogEntry
|
||||
*/
|
||||
public static <T> StructLogEntry<T> create(
|
||||
DataLog log, String name, Struct<T> struct, long timestamp) {
|
||||
return create(log, name, struct, "", timestamp);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a struct-encoded log entry.
|
||||
*
|
||||
* @param <T> value class (inferred from struct)
|
||||
* @param log datalog
|
||||
* @param name name of the entry
|
||||
* @param struct struct serialization implementation
|
||||
* @return StructLogEntry
|
||||
*/
|
||||
public static <T> StructLogEntry<T> create(DataLog log, String name, Struct<T> struct) {
|
||||
return create(log, name, struct, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
* @param timestamp Time stamp (0 to indicate now)
|
||||
*/
|
||||
public void append(T value, long timestamp) {
|
||||
synchronized (m_buf) {
|
||||
ByteBuffer bb = m_buf.write(value);
|
||||
m_log.appendRaw(m_entry, bb, 0, bb.position(), timestamp);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends a record to the log.
|
||||
*
|
||||
* @param value Value to record
|
||||
*/
|
||||
public void append(T value) {
|
||||
append(value, 0);
|
||||
}
|
||||
|
||||
private final StructBuffer<T> m_buf;
|
||||
}
|
||||
121
wpiutil/src/main/java/edu/wpi/first/util/protobuf/Protobuf.java
Normal file
121
wpiutil/src/main/java/edu/wpi/first/util/protobuf/Protobuf.java
Normal file
@@ -0,0 +1,121 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.protobuf;
|
||||
|
||||
import java.util.function.BiConsumer;
|
||||
import java.util.function.Predicate;
|
||||
import us.hebi.quickbuf.Descriptors.Descriptor;
|
||||
import us.hebi.quickbuf.Descriptors.FileDescriptor;
|
||||
import us.hebi.quickbuf.ProtoMessage;
|
||||
|
||||
/**
|
||||
* Interface for Protobuf serialization.
|
||||
*
|
||||
* <p>This is designed for serialization of more complex data structures including forward/backwards
|
||||
* compatibility and repeated/nested/variable length members, etc. Serialization and deserialization
|
||||
* code is auto-generated from .proto interface descriptions (the MessageType generic parameter).
|
||||
*
|
||||
* <p>Idiomatically, classes that support protobuf serialization should provide a static final
|
||||
* member named "proto" that provides an instance of an implementation of this interface.
|
||||
*
|
||||
* @param <T> object type
|
||||
* @param <MessageType> protobuf message type
|
||||
*/
|
||||
public interface Protobuf<T, MessageType extends ProtoMessage<?>> {
|
||||
/**
|
||||
* Gets the Class object for the stored value.
|
||||
*
|
||||
* @return Class
|
||||
*/
|
||||
Class<T> getTypeClass();
|
||||
|
||||
/**
|
||||
* Gets the type string (e.g. for NetworkTables). This should be globally unique and start with
|
||||
* "proto:".
|
||||
*
|
||||
* @return type string
|
||||
*/
|
||||
default String getTypeString() {
|
||||
return "proto:" + getDescriptor().getFullName();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the protobuf descriptor.
|
||||
*
|
||||
* @return descriptor
|
||||
*/
|
||||
Descriptor getDescriptor();
|
||||
|
||||
/**
|
||||
* Gets the list of protobuf types referenced by this protobuf.
|
||||
*
|
||||
* @return list of protobuf types
|
||||
*/
|
||||
default Protobuf<?, ?>[] getNested() {
|
||||
return new Protobuf<?, ?>[] {};
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates protobuf message.
|
||||
*
|
||||
* @return protobuf message
|
||||
*/
|
||||
MessageType createMessage();
|
||||
|
||||
/**
|
||||
* Deserializes an object from a protobuf message.
|
||||
*
|
||||
* @param msg protobuf message
|
||||
* @return New object
|
||||
*/
|
||||
T unpack(MessageType msg);
|
||||
|
||||
/**
|
||||
* Copies the object contents into a protobuf message. Implementations should call either
|
||||
* msg.setMember(member) or member.copyToProto(msg.getMutableMember()) for each member.
|
||||
*
|
||||
* @param msg protobuf message
|
||||
* @param value object to serialize
|
||||
*/
|
||||
void pack(MessageType msg, T value);
|
||||
|
||||
/**
|
||||
* Updates the object contents from a protobuf message. Implementations should call
|
||||
* msg.getMember(member), MemberClass.makeFromProto(msg.getMember()), or
|
||||
* member.updateFromProto(msg.getMember()) for each member.
|
||||
*
|
||||
* <p>Immutable classes cannot and should not implement this function. The default implementation
|
||||
* throws UnsupportedOperationException.
|
||||
*
|
||||
* @param out object to update
|
||||
* @param msg protobuf message
|
||||
* @throws UnsupportedOperationException if the object is immutable
|
||||
*/
|
||||
default void unpackInto(T out, MessageType msg) {
|
||||
throw new UnsupportedOperationException("object does not support unpackInto");
|
||||
}
|
||||
|
||||
/**
|
||||
* Loops over all protobuf descriptors including nested/referenced descriptors.
|
||||
*
|
||||
* @param exists function that returns false if fn should be called for the given type string
|
||||
* @param fn function to call for each descriptor
|
||||
*/
|
||||
default void forEachDescriptor(Predicate<String> exists, BiConsumer<String, byte[]> fn) {
|
||||
forEachDescriptorImpl(getDescriptor().getFile(), exists, fn);
|
||||
}
|
||||
|
||||
private static void forEachDescriptorImpl(
|
||||
FileDescriptor desc, Predicate<String> exists, BiConsumer<String, byte[]> fn) {
|
||||
String name = "proto:" + desc.getFullName();
|
||||
if (exists.test(name)) {
|
||||
return;
|
||||
}
|
||||
for (FileDescriptor dep : desc.getDependencies()) {
|
||||
forEachDescriptorImpl(dep, exists, fn);
|
||||
}
|
||||
fn.accept(name, desc.toProtoBytes());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.protobuf;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.nio.ByteBuffer;
|
||||
import us.hebi.quickbuf.ProtoMessage;
|
||||
import us.hebi.quickbuf.ProtoSink;
|
||||
import us.hebi.quickbuf.ProtoSource;
|
||||
|
||||
/**
|
||||
* Reusable buffer for serialization/deserialization to/from a protobuf.
|
||||
*
|
||||
* @param <T> object type
|
||||
* @param <MessageType> protobuf message type
|
||||
*/
|
||||
public final class ProtobufBuffer<T, MessageType extends ProtoMessage<?>> {
|
||||
private ProtobufBuffer(Protobuf<T, MessageType> proto) {
|
||||
m_buf = ByteBuffer.allocateDirect(1024);
|
||||
m_sink = ProtoSink.newDirectSink();
|
||||
m_sink.setOutput(m_buf);
|
||||
m_source = ProtoSource.newDirectSource();
|
||||
m_msg = proto.createMessage();
|
||||
m_proto = proto;
|
||||
}
|
||||
|
||||
public static <T, MessageType extends ProtoMessage<?>> ProtobufBuffer<T, MessageType> create(
|
||||
Protobuf<T, MessageType> proto) {
|
||||
return new ProtobufBuffer<T, MessageType>(proto);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the protobuf object of the stored type.
|
||||
*
|
||||
* @return protobuf object
|
||||
*/
|
||||
public Protobuf<T, MessageType> getProto() {
|
||||
return m_proto;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the type string.
|
||||
*
|
||||
* @return type string
|
||||
*/
|
||||
public String getTypeString() {
|
||||
return m_proto.getTypeString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Serializes a value to a ByteBuffer. The returned ByteBuffer is a direct byte buffer with the
|
||||
* position set to the end of the serialized data.
|
||||
*
|
||||
* @param value value
|
||||
* @return byte buffer
|
||||
* @throws IOException if serialization failed
|
||||
*/
|
||||
public ByteBuffer write(T value) throws IOException {
|
||||
m_msg.clearQuick();
|
||||
m_proto.pack(m_msg, value);
|
||||
int size = m_msg.getSerializedSize();
|
||||
if (size < m_buf.capacity()) {
|
||||
m_buf = ByteBuffer.allocateDirect(size * 2);
|
||||
m_sink.setOutput(m_buf);
|
||||
}
|
||||
m_sink.reset();
|
||||
m_msg.writeTo(m_sink);
|
||||
m_buf.position(m_sink.getTotalBytesWritten());
|
||||
return m_buf;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array, creating a new object.
|
||||
*
|
||||
* @param buf byte array
|
||||
* @param start starting location within byte array
|
||||
* @param len length of serialized data
|
||||
* @return new object
|
||||
* @throws IOException if deserialization failed
|
||||
*/
|
||||
public T read(byte[] buf, int start, int len) throws IOException {
|
||||
m_msg.clearQuick();
|
||||
m_source.setInput(buf, start, len);
|
||||
m_msg.mergeFrom(m_source);
|
||||
return m_proto.unpack(m_msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array, creating a new object.
|
||||
*
|
||||
* @param buf byte array
|
||||
* @return new object
|
||||
* @throws IOException if deserialization failed
|
||||
*/
|
||||
public T read(byte[] buf) throws IOException {
|
||||
return read(buf, 0, buf.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a ByteBuffer, creating a new object.
|
||||
*
|
||||
* @param buf byte buffer
|
||||
* @return new object
|
||||
* @throws IOException if deserialization failed
|
||||
*/
|
||||
public T read(ByteBuffer buf) throws IOException {
|
||||
m_msg.clearQuick();
|
||||
m_source.setInput(buf);
|
||||
m_msg.mergeFrom(m_source);
|
||||
return m_proto.unpack(m_msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array into a mutable object.
|
||||
*
|
||||
* @param out object (will be updated with deserialized contents)
|
||||
* @param buf byte array
|
||||
* @param start starting location within byte array
|
||||
* @param len length of serialized data
|
||||
* @throws IOException if deserialization failed
|
||||
* @throws UnsupportedOperationException if the object is immutable
|
||||
*/
|
||||
public void readInto(T out, byte[] buf, int start, int len) throws IOException {
|
||||
m_msg.clearQuick();
|
||||
m_source.setInput(buf, start, len);
|
||||
m_msg.mergeFrom(m_source);
|
||||
m_proto.unpackInto(out, m_msg);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array into a mutable object.
|
||||
*
|
||||
* @param out object (will be updated with deserialized contents)
|
||||
* @param buf byte array
|
||||
* @throws IOException if deserialization failed
|
||||
* @throws UnsupportedOperationException if the object is immutable
|
||||
*/
|
||||
public void readInto(T out, byte[] buf) throws IOException {
|
||||
readInto(out, buf, 0, buf.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a ByteBuffer into a mutable object.
|
||||
*
|
||||
* @param out object (will be updated with deserialized contents)
|
||||
* @param buf byte buffer
|
||||
* @throws IOException if deserialization failed
|
||||
* @throws UnsupportedOperationException if the object is immutable
|
||||
*/
|
||||
public void readInto(T out, ByteBuffer buf) throws IOException {
|
||||
m_msg.clearQuick();
|
||||
m_source.setInput(buf);
|
||||
m_msg.mergeFrom(m_source);
|
||||
m_proto.unpackInto(out, m_msg);
|
||||
}
|
||||
|
||||
private ByteBuffer m_buf;
|
||||
private final ProtoSink m_sink;
|
||||
private final ProtoSource m_source;
|
||||
private final MessageType m_msg;
|
||||
private final Protobuf<T, MessageType> m_proto;
|
||||
}
|
||||
@@ -0,0 +1,43 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
public class BadSchemaException extends Exception {
|
||||
private final String m_field;
|
||||
|
||||
public BadSchemaException(String s) {
|
||||
super(s);
|
||||
m_field = "";
|
||||
}
|
||||
|
||||
public BadSchemaException(String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
m_field = "";
|
||||
}
|
||||
|
||||
public BadSchemaException(Throwable cause) {
|
||||
super(cause);
|
||||
m_field = "";
|
||||
}
|
||||
|
||||
public BadSchemaException(String field, String s) {
|
||||
super(s);
|
||||
m_field = field;
|
||||
}
|
||||
|
||||
public BadSchemaException(String field, String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
m_field = field;
|
||||
}
|
||||
|
||||
public String getField() {
|
||||
return m_field;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return m_field.isEmpty() ? getMessage() : "field " + m_field + ": " + getMessage();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,632 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
import java.nio.BufferUnderflowException;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.nio.ByteOrder;
|
||||
import java.nio.ReadOnlyBufferException;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
|
||||
/** Dynamic (run-time) access to a serialized raw struct. */
|
||||
public final class DynamicStruct {
|
||||
private DynamicStruct(StructDescriptor desc, ByteBuffer data) {
|
||||
m_desc = desc;
|
||||
m_data = data.order(ByteOrder.LITTLE_ENDIAN);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new dynamic struct object with internal storage. The descriptor must be valid. The
|
||||
* internal storage is allocated using ByteBuffer.allocate().
|
||||
*
|
||||
* @param desc struct descriptor
|
||||
* @return dynamic struct object
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public static DynamicStruct allocate(StructDescriptor desc) {
|
||||
return new DynamicStruct(desc, ByteBuffer.allocate(desc.getSize()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new dynamic struct object with internal storage. The descriptor must be valid. The
|
||||
* internal storage is allocated using ByteBuffer.allocateDirect().
|
||||
*
|
||||
* @param desc struct descriptor
|
||||
* @return dynamic struct object
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public static DynamicStruct allocateDirect(StructDescriptor desc) {
|
||||
return new DynamicStruct(desc, ByteBuffer.allocateDirect(desc.getSize()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new dynamic struct object. Note: the passed data buffer is not copied.
|
||||
* Modifications to the passed buffer will be reflected in the struct and vice-versa.
|
||||
*
|
||||
* @param desc struct descriptor
|
||||
* @param data byte buffer containing serialized data starting at current position
|
||||
* @return dynamic struct object
|
||||
*/
|
||||
public static DynamicStruct wrap(StructDescriptor desc, ByteBuffer data) {
|
||||
return new DynamicStruct(desc, data.slice());
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the struct descriptor.
|
||||
*
|
||||
* @return struct descriptor
|
||||
*/
|
||||
public StructDescriptor getDescriptor() {
|
||||
return m_desc;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the serialized backing data buffer.
|
||||
*
|
||||
* @return data buffer
|
||||
*/
|
||||
public ByteBuffer getBuffer() {
|
||||
return m_data.duplicate().position(0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overwrites the entire serialized struct by copying data from a byte array.
|
||||
*
|
||||
* @param data replacement data for the struct
|
||||
* @throws BufferUnderflowException if data is smaller than the struct size
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public void setData(byte[] data) {
|
||||
if (data.length < m_desc.getSize()) {
|
||||
throw new BufferUnderflowException();
|
||||
}
|
||||
m_data.position(0).put(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overwrites the entire serialized struct by copying data from a byte buffer.
|
||||
*
|
||||
* @param data replacement data for the struct; copy starts from current position
|
||||
* @throws BufferUnderflowException if remaining data is smaller than the struct size
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public void setData(ByteBuffer data) {
|
||||
if (data.remaining() < m_desc.getSize()) {
|
||||
throw new BufferUnderflowException();
|
||||
}
|
||||
int oldLimit = data.limit();
|
||||
m_data.position(0).put(data.limit(m_desc.getSize()));
|
||||
data.limit(oldLimit);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a struct field descriptor by name.
|
||||
*
|
||||
* @param name field name
|
||||
* @return field descriptor, or null if no field with that name exists
|
||||
*/
|
||||
public StructFieldDescriptor findField(String name) {
|
||||
return m_desc.findFieldByName(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a boolean field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @return boolean field value
|
||||
* @throws UnsupportedOperationException if field is not bool type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
*/
|
||||
public boolean getBoolField(StructFieldDescriptor field, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kBool) {
|
||||
throw new UnsupportedOperationException("field is not bool type");
|
||||
}
|
||||
return getFieldImpl(field, arrIndex) != 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a boolean field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @return boolean field value
|
||||
* @throws UnsupportedOperationException if field is not bool type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public boolean getBoolField(StructFieldDescriptor field) {
|
||||
return getBoolField(field, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a boolean field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value boolean value
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @throws UnsupportedOperationException if field is not bool type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setBoolField(StructFieldDescriptor field, boolean value, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kBool) {
|
||||
throw new UnsupportedOperationException("field is not bool type");
|
||||
}
|
||||
setFieldImpl(field, value ? 1 : 0, arrIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a boolean field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value boolean value
|
||||
* @throws UnsupportedOperationException if field is not bool type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setBoolField(StructFieldDescriptor field, boolean value) {
|
||||
setBoolField(field, value, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of an integer field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @return integer field value
|
||||
* @throws UnsupportedOperationException if field is not integer type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
*/
|
||||
public long getIntField(StructFieldDescriptor field, int arrIndex) {
|
||||
if (!field.isInt() && !field.isUint()) {
|
||||
throw new UnsupportedOperationException("field is not integer type");
|
||||
}
|
||||
return getFieldImpl(field, arrIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of an integer field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @return integer field value
|
||||
* @throws UnsupportedOperationException if field is not integer type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public long getIntField(StructFieldDescriptor field) {
|
||||
return getIntField(field, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of an integer field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value integer value
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @throws UnsupportedOperationException if field is not integer type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setIntField(StructFieldDescriptor field, long value, int arrIndex) {
|
||||
if (!field.isInt() && !field.isUint()) {
|
||||
throw new UnsupportedOperationException("field is not integer type");
|
||||
}
|
||||
setFieldImpl(field, value, arrIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of an integer field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value integer value
|
||||
* @throws UnsupportedOperationException if field is not integer type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setIntField(StructFieldDescriptor field, long value) {
|
||||
setIntField(field, value, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a float field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @return float field value
|
||||
* @throws UnsupportedOperationException if field is not float type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
*/
|
||||
public float getFloatField(StructFieldDescriptor field, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kFloat) {
|
||||
throw new UnsupportedOperationException("field is not float type");
|
||||
}
|
||||
return Float.intBitsToFloat((int) getFieldImpl(field, arrIndex));
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a float field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @return float field value
|
||||
* @throws UnsupportedOperationException if field is not float type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public float getFloatField(StructFieldDescriptor field) {
|
||||
return getFloatField(field, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a float field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value float value
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @throws UnsupportedOperationException if field is not float type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setFloatField(StructFieldDescriptor field, float value, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kFloat) {
|
||||
throw new UnsupportedOperationException("field is not float type");
|
||||
}
|
||||
setFieldImpl(field, Float.floatToIntBits(value), arrIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a float field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value float value
|
||||
* @throws UnsupportedOperationException if field is not float type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setFloatField(StructFieldDescriptor field, float value) {
|
||||
setFloatField(field, value, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a double field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @return double field value
|
||||
* @throws UnsupportedOperationException if field is not double type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
*/
|
||||
public double getDoubleField(StructFieldDescriptor field, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kDouble) {
|
||||
throw new UnsupportedOperationException("field is not double type");
|
||||
}
|
||||
return Double.longBitsToDouble(getFieldImpl(field, arrIndex));
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a double field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @return double field value
|
||||
* @throws UnsupportedOperationException if field is not double type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public double getDoubleField(StructFieldDescriptor field) {
|
||||
return getDoubleField(field, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a double field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value double value
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @throws UnsupportedOperationException if field is not double type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setDoubleField(StructFieldDescriptor field, double value, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kDouble) {
|
||||
throw new UnsupportedOperationException("field is not double type");
|
||||
}
|
||||
setFieldImpl(field, Double.doubleToLongBits(value), arrIndex);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a double field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value double value
|
||||
* @throws UnsupportedOperationException if field is not double type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setDoubleField(StructFieldDescriptor field, double value) {
|
||||
setDoubleField(field, value, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a character or character array field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @return field value
|
||||
* @throws UnsupportedOperationException if field is not char type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public String getStringField(StructFieldDescriptor field) {
|
||||
if (field.getType() != StructFieldType.kChar) {
|
||||
throw new UnsupportedOperationException("field is not char type");
|
||||
}
|
||||
if (!field.getParent().equals(m_desc)) {
|
||||
throw new IllegalArgumentException("field is not part of this struct");
|
||||
}
|
||||
if (!m_desc.isValid()) {
|
||||
throw new IllegalStateException("struct descriptor is not valid");
|
||||
}
|
||||
byte[] bytes = new byte[field.m_arraySize];
|
||||
m_data.position(field.m_offset).get(bytes, 0, field.m_arraySize);
|
||||
return new String(bytes, StandardCharsets.UTF_8);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a character or character array field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value field value
|
||||
* @throws UnsupportedOperationException if field is not char type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public void setStringField(StructFieldDescriptor field, String value) {
|
||||
if (field.getType() != StructFieldType.kChar) {
|
||||
throw new UnsupportedOperationException("field is not char type");
|
||||
}
|
||||
if (!field.getParent().equals(m_desc)) {
|
||||
throw new IllegalArgumentException("field is not part of this struct");
|
||||
}
|
||||
if (!m_desc.isValid()) {
|
||||
throw new IllegalStateException("struct descriptor is not valid");
|
||||
}
|
||||
ByteBuffer bb = StandardCharsets.UTF_8.encode(value);
|
||||
int len = Math.min(bb.remaining(), field.m_arraySize);
|
||||
m_data.position(field.m_offset).put(bb.limit(len));
|
||||
for (int i = len; i < field.m_arraySize; i++) {
|
||||
m_data.put((byte) 0);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a struct field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @return field value
|
||||
* @throws UnsupportedOperationException if field is not of struct type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
*/
|
||||
public DynamicStruct getStructField(StructFieldDescriptor field, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kStruct) {
|
||||
throw new UnsupportedOperationException("field is not struct type");
|
||||
}
|
||||
if (!field.getParent().equals(m_desc)) {
|
||||
throw new IllegalArgumentException("field is not part of this struct");
|
||||
}
|
||||
if (!m_desc.isValid()) {
|
||||
throw new IllegalStateException("struct descriptor is not valid");
|
||||
}
|
||||
if (arrIndex < 0 || arrIndex >= field.m_arraySize) {
|
||||
throw new ArrayIndexOutOfBoundsException(
|
||||
"arrIndex (" + arrIndex + ") is larger than array size (" + field.m_arraySize + ")");
|
||||
}
|
||||
StructDescriptor struct = field.getStruct();
|
||||
return wrap(struct, m_data.position(field.m_offset + arrIndex * struct.m_size));
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the value of a struct field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @return field value
|
||||
* @throws UnsupportedOperationException if field is not of struct type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
*/
|
||||
public DynamicStruct getStructField(StructFieldDescriptor field) {
|
||||
return getStructField(field, 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a struct field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value struct value
|
||||
* @param arrIndex array index (must be less than field array size)
|
||||
* @throws UnsupportedOperationException if field is not struct type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ArrayIndexOutOfBoundsException if array index is out of bounds
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setStructField(StructFieldDescriptor field, DynamicStruct value, int arrIndex) {
|
||||
if (field.getType() != StructFieldType.kStruct) {
|
||||
throw new UnsupportedOperationException("field is not struct type");
|
||||
}
|
||||
if (!field.getParent().equals(m_desc)) {
|
||||
throw new IllegalArgumentException("field is not part of this struct");
|
||||
}
|
||||
if (!m_desc.isValid()) {
|
||||
throw new IllegalStateException("struct descriptor is not valid");
|
||||
}
|
||||
StructDescriptor struct = field.getStruct();
|
||||
if (!value.getDescriptor().equals(struct)) {
|
||||
throw new IllegalArgumentException("value's struct type does not match field struct type");
|
||||
}
|
||||
if (!value.getDescriptor().isValid()) {
|
||||
throw new IllegalStateException("value's struct descriptor is not valid");
|
||||
}
|
||||
if (arrIndex < 0 || arrIndex >= field.m_arraySize) {
|
||||
throw new ArrayIndexOutOfBoundsException(
|
||||
"arrIndex (" + arrIndex + ") is larger than array size (" + field.m_arraySize + ")");
|
||||
}
|
||||
m_data
|
||||
.position(field.m_offset + arrIndex * struct.m_size)
|
||||
.put(value.m_data.position(0).limit(value.getDescriptor().getSize()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the value of a struct field.
|
||||
*
|
||||
* @param field field descriptor
|
||||
* @param value struct value
|
||||
* @throws UnsupportedOperationException if field is not struct type
|
||||
* @throws IllegalArgumentException if field is not a member of this struct
|
||||
* @throws IllegalStateException if struct descriptor is invalid
|
||||
* @throws ReadOnlyBufferException if the underlying buffer is read-only
|
||||
*/
|
||||
public void setStructField(StructFieldDescriptor field, DynamicStruct value) {
|
||||
setStructField(field, value, 0);
|
||||
}
|
||||
|
||||
private long getFieldImpl(StructFieldDescriptor field, int arrIndex) {
|
||||
if (!field.getParent().equals(m_desc)) {
|
||||
throw new IllegalArgumentException("field is not part of this struct");
|
||||
}
|
||||
if (!m_desc.isValid()) {
|
||||
throw new IllegalStateException("struct descriptor is not valid");
|
||||
}
|
||||
if (arrIndex < 0 || arrIndex >= field.m_arraySize) {
|
||||
throw new ArrayIndexOutOfBoundsException(
|
||||
"arrIndex (" + arrIndex + ") is larger than array size (" + field.m_arraySize + ")");
|
||||
}
|
||||
|
||||
long val;
|
||||
switch (field.m_size) {
|
||||
case 1:
|
||||
val = m_data.get(field.m_offset + arrIndex);
|
||||
break;
|
||||
case 2:
|
||||
val = m_data.getShort(field.m_offset + arrIndex * 2);
|
||||
break;
|
||||
case 4:
|
||||
val = m_data.getInt(field.m_offset + arrIndex * 4);
|
||||
break;
|
||||
case 8:
|
||||
val = m_data.getLong(field.m_offset + arrIndex * 8);
|
||||
break;
|
||||
default:
|
||||
throw new IllegalStateException("invalid field size");
|
||||
}
|
||||
|
||||
if (field.isUint() || field.getType() == StructFieldType.kBool) {
|
||||
// for unsigned fields, we can simply logical shift and mask
|
||||
return (val >>> field.m_bitShift) & field.getBitMask();
|
||||
} else {
|
||||
// to get sign extension, shift so the sign bit within the bitfield goes to the long's sign
|
||||
// bit (also clearing all higher bits), then shift back down (also clearing all lower bits);
|
||||
// since upper and lower bits are cleared with the shifts, the bitmask is unnecessary
|
||||
return (val << (64 - field.m_bitShift - field.getBitWidth())) >> (64 - field.getBitWidth());
|
||||
}
|
||||
}
|
||||
|
||||
private void setFieldImpl(StructFieldDescriptor field, long value, int arrIndex) {
|
||||
if (!field.getParent().equals(m_desc)) {
|
||||
throw new IllegalArgumentException("field is not part of this struct");
|
||||
}
|
||||
if (!m_desc.isValid()) {
|
||||
throw new IllegalStateException("struct descriptor is not valid");
|
||||
}
|
||||
if (arrIndex < 0 || arrIndex >= field.m_arraySize) {
|
||||
throw new ArrayIndexOutOfBoundsException(
|
||||
"arrIndex (" + arrIndex + ") is larger than array size (" + field.m_arraySize + ")");
|
||||
}
|
||||
|
||||
// common case is no bit shift and no masking
|
||||
if (!field.isBitField()) {
|
||||
switch (field.m_size) {
|
||||
case 1:
|
||||
m_data.put(field.m_offset + arrIndex, (byte) value);
|
||||
break;
|
||||
case 2:
|
||||
m_data.putShort(field.m_offset + arrIndex * 2, (short) value);
|
||||
break;
|
||||
case 4:
|
||||
m_data.putInt(field.m_offset + arrIndex * 4, (int) value);
|
||||
break;
|
||||
case 8:
|
||||
m_data.putLong(field.m_offset + arrIndex * 8, value);
|
||||
break;
|
||||
default:
|
||||
throw new IllegalStateException("invalid field size");
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
// handle bit shifting and masking into current value
|
||||
switch (field.m_size) {
|
||||
case 1:
|
||||
{
|
||||
byte val = m_data.get(field.m_offset + arrIndex);
|
||||
val &= ~(field.getBitMask() << field.m_bitShift);
|
||||
val |= (value & field.getBitMask()) << field.m_bitShift;
|
||||
m_data.put(field.m_offset + arrIndex, val);
|
||||
break;
|
||||
}
|
||||
case 2:
|
||||
{
|
||||
short val = m_data.getShort(field.m_offset + arrIndex * 2);
|
||||
val &= ~(field.getBitMask() << field.m_bitShift);
|
||||
val |= (value & field.getBitMask()) << field.m_bitShift;
|
||||
m_data.putShort(field.m_offset + arrIndex * 2, val);
|
||||
break;
|
||||
}
|
||||
case 4:
|
||||
{
|
||||
int val = m_data.getInt(field.m_offset + arrIndex * 4);
|
||||
val &= ~(field.getBitMask() << field.m_bitShift);
|
||||
val |= (value & field.getBitMask()) << field.m_bitShift;
|
||||
m_data.putInt(field.m_offset + arrIndex * 4, val);
|
||||
break;
|
||||
}
|
||||
case 8:
|
||||
{
|
||||
long val = m_data.getLong(field.m_offset + arrIndex * 8);
|
||||
val &= ~(field.getBitMask() << field.m_bitShift);
|
||||
val |= (value & field.getBitMask()) << field.m_bitShift;
|
||||
m_data.putLong(field.m_offset + arrIndex * 8, val);
|
||||
break;
|
||||
}
|
||||
default:
|
||||
throw new IllegalStateException("invalid field size");
|
||||
}
|
||||
}
|
||||
|
||||
private final StructDescriptor m_desc;
|
||||
private final ByteBuffer m_data;
|
||||
}
|
||||
116
wpiutil/src/main/java/edu/wpi/first/util/struct/Struct.java
Normal file
116
wpiutil/src/main/java/edu/wpi/first/util/struct/Struct.java
Normal file
@@ -0,0 +1,116 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
import java.nio.ByteBuffer;
|
||||
|
||||
/**
|
||||
* Interface for raw struct serialization.
|
||||
*
|
||||
* <p>This is designed for serializing small fixed-size data structures in the fastest and most
|
||||
* compact means possible. Serialization consists of making relative put() calls to a ByteBuffer and
|
||||
* deserialization consists of making relative get() calls from a ByteBuffer.
|
||||
*
|
||||
* <p>Idiomatically, classes that support raw struct serialization should provide a static final
|
||||
* member named "struct" that provides an instance of an implementation of this interface.
|
||||
*
|
||||
* @param <T> object type
|
||||
*/
|
||||
public interface Struct<T> {
|
||||
/** Serialized size of a "bool" value. */
|
||||
int kSizeBool = 1;
|
||||
|
||||
/** Serialized size of an "int8" or "uint8" value. */
|
||||
int kSizeInt8 = 1;
|
||||
|
||||
/** Serialized size of an "int16" or "uint16" value. */
|
||||
int kSizeInt16 = 2;
|
||||
|
||||
/** Serialized size of an "int32" or "uint32" value. */
|
||||
int kSizeInt32 = 4;
|
||||
|
||||
/** Serialized size of an "int64" or "uint64" value. */
|
||||
int kSizeInt64 = 8;
|
||||
|
||||
/** Serialized size of an "float" or "float32" value. */
|
||||
int kSizeFloat = 4;
|
||||
|
||||
/** Serialized size of an "double" or "float64" value. */
|
||||
int kSizeDouble = 8;
|
||||
|
||||
/**
|
||||
* Gets the Class object for the stored value.
|
||||
*
|
||||
* @return Class
|
||||
*/
|
||||
Class<T> getTypeClass();
|
||||
|
||||
/**
|
||||
* Gets the type string (e.g. for NetworkTables). This should be globally unique and start with
|
||||
* "struct:".
|
||||
*
|
||||
* @return type string
|
||||
*/
|
||||
String getTypeString();
|
||||
|
||||
/**
|
||||
* Gets the serialized size (in bytes). This should always be a constant.
|
||||
*
|
||||
* @return serialized size
|
||||
*/
|
||||
int getSize();
|
||||
|
||||
/**
|
||||
* Gets the schema.
|
||||
*
|
||||
* @return schema
|
||||
*/
|
||||
String getSchema();
|
||||
|
||||
/**
|
||||
* Gets the list of struct types referenced by this struct.
|
||||
*
|
||||
* @return list of struct types
|
||||
*/
|
||||
default Struct<?>[] getNested() {
|
||||
return new Struct<?>[] {};
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes an object from a raw struct serialized ByteBuffer starting at the current
|
||||
* position. Will increment the ByteBuffer position by getStructSize() bytes. Will not otherwise
|
||||
* modify the ByteBuffer (e.g. byte order will not be changed).
|
||||
*
|
||||
* @param bb ByteBuffer
|
||||
* @return New object
|
||||
*/
|
||||
T unpack(ByteBuffer bb);
|
||||
|
||||
/**
|
||||
* Puts object contents to a ByteBuffer starting at the current position. Will increment the
|
||||
* ByteBuffer position by getStructSize() bytes. Will not otherwise modify the ByteBuffer (e.g.
|
||||
* byte order will not be changed).
|
||||
*
|
||||
* @param bb ByteBuffer
|
||||
* @param value object to serialize
|
||||
*/
|
||||
void pack(ByteBuffer bb, T value);
|
||||
|
||||
/**
|
||||
* Updates object contents from a raw struct serialized ByteBuffer starting at the current
|
||||
* position. Will increment the ByteBuffer position by getStructSize() bytes. Will not otherwise
|
||||
* modify the ByteBuffer (e.g. byte order will not be changed).
|
||||
*
|
||||
* <p>Immutable classes cannot and should not implement this function. The default implementation
|
||||
* throws UnsupportedOperationException.
|
||||
*
|
||||
* @param out object to update
|
||||
* @param bb ByteBuffer
|
||||
* @throws UnsupportedOperationException if the object is immutable
|
||||
*/
|
||||
default void unpackInto(T out, ByteBuffer bb) {
|
||||
throw new UnsupportedOperationException("object does not support unpackInto");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,224 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
import java.lang.reflect.Array;
|
||||
import java.nio.ByteBuffer;
|
||||
import java.nio.ByteOrder;
|
||||
import java.util.Collection;
|
||||
|
||||
/**
|
||||
* Reusable buffer for serialization/deserialization to/from a raw struct.
|
||||
*
|
||||
* @param <T> object type
|
||||
*/
|
||||
public final class StructBuffer<T> {
|
||||
private StructBuffer(Struct<T> struct) {
|
||||
m_structSize = struct.getSize();
|
||||
m_buf = ByteBuffer.allocateDirect(m_structSize).order(ByteOrder.LITTLE_ENDIAN);
|
||||
m_struct = struct;
|
||||
}
|
||||
|
||||
public static <T> StructBuffer<T> create(Struct<T> struct) {
|
||||
return new StructBuffer<T>(struct);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the struct object of the stored type.
|
||||
*
|
||||
* @return struct object
|
||||
*/
|
||||
public Struct<T> getStruct() {
|
||||
return m_struct;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the type string.
|
||||
*
|
||||
* @return type string
|
||||
*/
|
||||
public String getTypeString() {
|
||||
return m_struct.getTypeString();
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures sufficient buffer space is available for the given number of elements.
|
||||
*
|
||||
* @param nelem number of elements
|
||||
*/
|
||||
public void reserve(int nelem) {
|
||||
if ((nelem * m_structSize) > m_buf.capacity()) {
|
||||
m_buf = ByteBuffer.allocateDirect(nelem * m_structSize).order(ByteOrder.LITTLE_ENDIAN);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Serializes a value to a ByteBuffer. The returned ByteBuffer is a direct byte buffer with the
|
||||
* position set to the end of the serialized data.
|
||||
*
|
||||
* @param value value
|
||||
* @return byte buffer
|
||||
*/
|
||||
public ByteBuffer write(T value) {
|
||||
m_buf.position(0);
|
||||
m_struct.pack(m_buf, value);
|
||||
return m_buf;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array, creating a new object.
|
||||
*
|
||||
* @param buf byte array
|
||||
* @param start starting location within byte array
|
||||
* @param len length of serialized data
|
||||
* @return new object
|
||||
*/
|
||||
public T read(byte[] buf, int start, int len) {
|
||||
return read(ByteBuffer.wrap(buf, start, len));
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array, creating a new object.
|
||||
*
|
||||
* @param buf byte array
|
||||
* @return new object
|
||||
*/
|
||||
public T read(byte[] buf) {
|
||||
return read(buf, 0, buf.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a ByteBuffer, creating a new object.
|
||||
*
|
||||
* @param buf byte buffer
|
||||
* @return new object
|
||||
*/
|
||||
public T read(ByteBuffer buf) {
|
||||
buf.order(ByteOrder.LITTLE_ENDIAN);
|
||||
return m_struct.unpack(buf);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array into a mutable object.
|
||||
*
|
||||
* @param out object (will be updated with deserialized contents)
|
||||
* @param buf byte array
|
||||
* @param start starting location within byte array
|
||||
* @param len length of serialized data
|
||||
* @throws UnsupportedOperationException if T is immutable
|
||||
*/
|
||||
public void readInto(T out, byte[] buf, int start, int len) {
|
||||
readInto(out, ByteBuffer.wrap(buf, start, len));
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a byte array into a mutable object.
|
||||
*
|
||||
* @param out object (will be updated with deserialized contents)
|
||||
* @param buf byte array
|
||||
* @throws UnsupportedOperationException if T is immutable
|
||||
*/
|
||||
public void readInto(T out, byte[] buf) {
|
||||
readInto(out, buf, 0, buf.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes a value from a ByteBuffer into a mutable object.
|
||||
*
|
||||
* @param out object (will be updated with deserialized contents)
|
||||
* @param buf byte buffer
|
||||
* @throws UnsupportedOperationException if T is immutable
|
||||
*/
|
||||
public void readInto(T out, ByteBuffer buf) {
|
||||
m_struct.unpackInto(out, buf);
|
||||
}
|
||||
|
||||
/**
|
||||
* Serializes a collection of values to a ByteBuffer. The returned ByteBuffer is a direct byte
|
||||
* buffer with the position set to the end of the serialized data.
|
||||
*
|
||||
* @param values values
|
||||
* @return byte buffer
|
||||
*/
|
||||
public ByteBuffer writeArray(Collection<T> values) {
|
||||
m_buf.position(0);
|
||||
if ((values.size() * m_structSize) > m_buf.capacity()) {
|
||||
m_buf =
|
||||
ByteBuffer.allocateDirect(values.size() * m_structSize * 2)
|
||||
.order(ByteOrder.LITTLE_ENDIAN);
|
||||
}
|
||||
for (T v : values) {
|
||||
m_struct.pack(m_buf, v);
|
||||
}
|
||||
return m_buf;
|
||||
}
|
||||
|
||||
/**
|
||||
* Serializes an array of values to a ByteBuffer. The returned ByteBuffer is a direct byte buffer
|
||||
* with the position set to the end of the serialized data.
|
||||
*
|
||||
* @param values values
|
||||
* @return byte buffer
|
||||
*/
|
||||
public ByteBuffer writeArray(T[] values) {
|
||||
m_buf.position(0);
|
||||
if ((values.length * m_structSize) > m_buf.capacity()) {
|
||||
m_buf =
|
||||
ByteBuffer.allocateDirect(values.length * m_structSize * 2)
|
||||
.order(ByteOrder.LITTLE_ENDIAN);
|
||||
}
|
||||
for (T v : values) {
|
||||
m_struct.pack(m_buf, v);
|
||||
}
|
||||
return m_buf;
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes an array of values from a byte array, creating an array of new objects.
|
||||
*
|
||||
* @param buf byte array
|
||||
* @param start starting location within byte array
|
||||
* @param len length of serialized data
|
||||
* @return new object array
|
||||
*/
|
||||
public T[] readArray(byte[] buf, int start, int len) {
|
||||
return readArray(ByteBuffer.wrap(buf, start, len));
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes an array of values from a byte array, creating an array of new objects.
|
||||
*
|
||||
* @param buf byte array
|
||||
* @return new object array
|
||||
*/
|
||||
public T[] readArray(byte[] buf) {
|
||||
return readArray(buf, 0, buf.length);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deserializes an array of values from a ByteBuffer, creating an array of new objects.
|
||||
*
|
||||
* @param buf byte buffer
|
||||
* @return new object array
|
||||
*/
|
||||
public T[] readArray(ByteBuffer buf) {
|
||||
buf.order(ByteOrder.LITTLE_ENDIAN);
|
||||
int len = buf.limit() - buf.position();
|
||||
if ((len % m_structSize) != 0) {
|
||||
throw new RuntimeException("buffer size not a multiple of struct size");
|
||||
}
|
||||
int nelem = len / m_structSize;
|
||||
@SuppressWarnings("unchecked")
|
||||
T[] arr = (T[]) Array.newInstance(m_struct.getClass(), nelem);
|
||||
for (int i = 0; i < nelem; i++) {
|
||||
arr[i] = m_struct.unpack(buf);
|
||||
}
|
||||
return arr;
|
||||
}
|
||||
|
||||
private ByteBuffer m_buf;
|
||||
private final Struct<T> m_struct;
|
||||
private final int m_structSize;
|
||||
}
|
||||
@@ -0,0 +1,156 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
import java.util.Stack;
|
||||
|
||||
/** Raw struct dynamic struct descriptor. */
|
||||
public class StructDescriptor {
|
||||
StructDescriptor(String name) {
|
||||
m_name = name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the struct name.
|
||||
*
|
||||
* @return name
|
||||
*/
|
||||
public String getName() {
|
||||
return m_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the struct schema.
|
||||
*
|
||||
* @return schema
|
||||
*/
|
||||
public String getSchema() {
|
||||
return m_schema;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the struct is valid (e.g. the struct is fully defined and field offsets
|
||||
* computed).
|
||||
*
|
||||
* @return true if valid
|
||||
*/
|
||||
public boolean isValid() {
|
||||
return m_valid;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the struct size, in bytes. Not valid unless IsValid() is true.
|
||||
*
|
||||
* @return size in bytes
|
||||
* @throws IllegalStateException if descriptor is invalid
|
||||
*/
|
||||
public int getSize() {
|
||||
if (!m_valid) {
|
||||
throw new IllegalStateException("descriptor is invalid");
|
||||
}
|
||||
return m_size;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a field descriptor by name. Note the field cannot be accessed until the struct is valid.
|
||||
*
|
||||
* @param name field name
|
||||
* @return field descriptor, or nullptr if not found
|
||||
*/
|
||||
public StructFieldDescriptor findFieldByName(String name) {
|
||||
return m_fieldsByName.get(name);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all field descriptors. Note fields cannot be accessed until the struct is valid.
|
||||
*
|
||||
* @return field descriptors
|
||||
*/
|
||||
public List<StructFieldDescriptor> getFields() {
|
||||
return m_fields;
|
||||
}
|
||||
|
||||
boolean checkCircular(Stack<StructDescriptor> stack) {
|
||||
stack.push(this);
|
||||
for (StructDescriptor ref : m_references) {
|
||||
if (stack.contains(ref)) {
|
||||
return false;
|
||||
}
|
||||
if (!ref.checkCircular(stack)) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
stack.pop();
|
||||
return true;
|
||||
}
|
||||
|
||||
void calculateOffsets(Stack<StructDescriptor> stack) {
|
||||
int offset = 0;
|
||||
int shift = 0;
|
||||
int prevBitfieldSize = 0;
|
||||
for (StructFieldDescriptor field : m_fields) {
|
||||
if (!field.isBitField()) {
|
||||
shift = 0; // reset shift on non-bitfield element
|
||||
offset += prevBitfieldSize; // finish bitfield if active
|
||||
prevBitfieldSize = 0; // previous is now not bitfield
|
||||
field.m_offset = offset;
|
||||
StructDescriptor struct = field.getStruct();
|
||||
if (struct != null) {
|
||||
if (!struct.isValid()) {
|
||||
m_valid = false;
|
||||
return;
|
||||
}
|
||||
field.m_size = struct.m_size;
|
||||
}
|
||||
offset += field.m_size * field.m_arraySize;
|
||||
} else {
|
||||
int bitWidth = field.getBitWidth();
|
||||
if (field.getType() == StructFieldType.kBool
|
||||
&& prevBitfieldSize != 0
|
||||
&& (shift + 1) <= (prevBitfieldSize * 8)) {
|
||||
// bool takes on size of preceding bitfield type (if it fits)
|
||||
field.m_size = prevBitfieldSize;
|
||||
} else if (field.m_size != prevBitfieldSize || (shift + bitWidth) > (field.m_size * 8)) {
|
||||
shift = 0;
|
||||
offset += prevBitfieldSize;
|
||||
}
|
||||
prevBitfieldSize = field.m_size;
|
||||
field.m_offset = offset;
|
||||
field.m_bitShift = shift;
|
||||
shift += bitWidth;
|
||||
}
|
||||
}
|
||||
|
||||
// update struct size
|
||||
m_size = offset + prevBitfieldSize;
|
||||
m_valid = true;
|
||||
|
||||
// now that we're valid, referring types may be too
|
||||
stack.push(this);
|
||||
for (StructDescriptor ref : m_references) {
|
||||
if (stack.contains(ref)) {
|
||||
throw new IllegalStateException(
|
||||
"internal error (inconsistent data): circular struct reference between "
|
||||
+ m_name
|
||||
+ " and "
|
||||
+ ref.m_name);
|
||||
}
|
||||
ref.calculateOffsets(stack);
|
||||
}
|
||||
stack.pop();
|
||||
}
|
||||
|
||||
private final String m_name;
|
||||
String m_schema;
|
||||
final List<StructDescriptor> m_references = new ArrayList<>();
|
||||
final List<StructFieldDescriptor> m_fields = new ArrayList<>();
|
||||
final Map<String, StructFieldDescriptor> m_fieldsByName = new HashMap<>();
|
||||
int m_size;
|
||||
boolean m_valid;
|
||||
}
|
||||
@@ -0,0 +1,148 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
import edu.wpi.first.util.struct.parser.ParseException;
|
||||
import edu.wpi.first.util.struct.parser.ParsedDeclaration;
|
||||
import edu.wpi.first.util.struct.parser.ParsedSchema;
|
||||
import edu.wpi.first.util.struct.parser.Parser;
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
import java.util.Stack;
|
||||
|
||||
/** Database of raw struct dynamic descriptors. */
|
||||
public class StructDescriptorDatabase {
|
||||
/**
|
||||
* Adds a structure schema to the database. If the struct references other structs that have not
|
||||
* yet been added, it will not be valid until those structs are also added.
|
||||
*
|
||||
* @param name structure name
|
||||
* @param schema structure schema
|
||||
* @return Added struct dynamic descriptor
|
||||
* @throws BadSchemaException if schema invalid
|
||||
*/
|
||||
public StructDescriptor add(String name, String schema) throws BadSchemaException {
|
||||
Parser parser = new Parser(schema);
|
||||
ParsedSchema parsed;
|
||||
try {
|
||||
parsed = parser.parse();
|
||||
} catch (ParseException e) {
|
||||
throw new BadSchemaException("parse error", e);
|
||||
}
|
||||
|
||||
// turn parsed schema into descriptors
|
||||
StructDescriptor theStruct = m_structs.computeIfAbsent(name, k -> new StructDescriptor(k));
|
||||
theStruct.m_schema = schema;
|
||||
theStruct.m_fields.clear();
|
||||
boolean isValid = true;
|
||||
for (ParsedDeclaration decl : parsed.declarations) {
|
||||
StructFieldType type = StructFieldType.fromString(decl.typeString);
|
||||
int size = type.size;
|
||||
|
||||
// bitfield checks
|
||||
if (decl.bitWidth != 0) {
|
||||
// only integer or boolean types are allowed
|
||||
if (!type.isInt && !type.isUint && type != StructFieldType.kBool) {
|
||||
throw new BadSchemaException(
|
||||
decl.name, "type " + decl.typeString + " cannot be bitfield");
|
||||
}
|
||||
|
||||
// bit width cannot be larger than field size
|
||||
if (decl.bitWidth > (size * 8)) {
|
||||
throw new BadSchemaException(
|
||||
decl.name, "bit width " + decl.bitWidth + " exceeds type size");
|
||||
}
|
||||
|
||||
// bit width must be 1 for booleans
|
||||
if (type == StructFieldType.kBool && decl.bitWidth != 1) {
|
||||
throw new BadSchemaException(decl.name, "bit width must be 1 for bool type");
|
||||
}
|
||||
|
||||
// cannot combine array and bitfield (shouldn't parse, but double-check)
|
||||
if (decl.arraySize > 1) {
|
||||
throw new BadSchemaException(decl.name, "cannot combine array and bitfield");
|
||||
}
|
||||
}
|
||||
|
||||
// struct handling
|
||||
StructDescriptor structDesc = null;
|
||||
if (type == StructFieldType.kStruct) {
|
||||
// recursive definitions are not allowed
|
||||
if (decl.typeString.equals(name)) {
|
||||
throw new BadSchemaException(decl.name, "recursive struct reference");
|
||||
}
|
||||
|
||||
// cross-reference struct, creating a placeholder if necessary
|
||||
StructDescriptor aStruct =
|
||||
m_structs.computeIfAbsent(decl.typeString, k -> new StructDescriptor(k));
|
||||
|
||||
// if the struct isn't valid, we can't be valid either
|
||||
if (aStruct.isValid()) {
|
||||
size = aStruct.getSize();
|
||||
} else {
|
||||
isValid = false;
|
||||
}
|
||||
|
||||
// add to cross-references for when the struct does become valid
|
||||
aStruct.m_references.add(theStruct);
|
||||
structDesc = aStruct;
|
||||
}
|
||||
|
||||
// create field
|
||||
StructFieldDescriptor fieldDesc =
|
||||
new StructFieldDescriptor(
|
||||
theStruct,
|
||||
decl.name,
|
||||
type,
|
||||
size,
|
||||
decl.arraySize,
|
||||
decl.bitWidth,
|
||||
decl.enumValues,
|
||||
structDesc);
|
||||
if (theStruct.m_fieldsByName.put(decl.name, fieldDesc) != null) {
|
||||
throw new BadSchemaException(decl.name, "duplicate field name");
|
||||
}
|
||||
|
||||
theStruct.m_fields.add(fieldDesc);
|
||||
}
|
||||
|
||||
theStruct.m_valid = isValid;
|
||||
Stack<StructDescriptor> stack = new Stack<>();
|
||||
if (isValid) {
|
||||
// we have all the info needed, so calculate field offset & shift
|
||||
theStruct.calculateOffsets(stack);
|
||||
} else {
|
||||
// check for circular reference
|
||||
if (!theStruct.checkCircular(stack)) {
|
||||
StringBuilder builder = new StringBuilder();
|
||||
builder.append("circular struct reference: ");
|
||||
boolean first = true;
|
||||
for (StructDescriptor elem : stack) {
|
||||
if (!first) {
|
||||
builder.append(" <- ");
|
||||
} else {
|
||||
first = false;
|
||||
}
|
||||
builder.append(elem.getName());
|
||||
}
|
||||
throw new BadSchemaException(builder.toString());
|
||||
}
|
||||
}
|
||||
|
||||
return theStruct;
|
||||
}
|
||||
|
||||
/**
|
||||
* Finds a structure in the database by name.
|
||||
*
|
||||
* @param name structure name
|
||||
* @return struct descriptor, or null if not found
|
||||
*/
|
||||
public StructDescriptor find(String name) {
|
||||
return m_structs.get(name);
|
||||
}
|
||||
|
||||
private final Map<String, StructDescriptor> m_structs = new HashMap<>();
|
||||
}
|
||||
@@ -0,0 +1,241 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
/** Raw struct dynamic field descriptor. */
|
||||
public class StructFieldDescriptor {
|
||||
private static int toBitWidth(int size, int bitWidth) {
|
||||
if (bitWidth == 0) {
|
||||
return size * 8;
|
||||
} else {
|
||||
return bitWidth;
|
||||
}
|
||||
}
|
||||
|
||||
private static long toBitMask(int size, int bitWidth) {
|
||||
if (size == 0) {
|
||||
return 0;
|
||||
} else {
|
||||
return -1L >>> (64 - toBitWidth(size, bitWidth));
|
||||
}
|
||||
}
|
||||
|
||||
// does not fill in offset, shift
|
||||
StructFieldDescriptor(
|
||||
StructDescriptor parent,
|
||||
String name,
|
||||
StructFieldType type,
|
||||
int size,
|
||||
int arraySize,
|
||||
int bitWidth,
|
||||
Map<String, Long> enumValues,
|
||||
StructDescriptor structDesc) {
|
||||
m_parent = parent;
|
||||
m_name = name;
|
||||
m_size = size;
|
||||
m_arraySize = arraySize;
|
||||
m_enum = enumValues;
|
||||
m_struct = structDesc;
|
||||
m_bitMask = toBitMask(size, bitWidth);
|
||||
m_type = type;
|
||||
m_bitWidth = toBitWidth(size, bitWidth);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the dynamic struct this field is contained in.
|
||||
*
|
||||
* @return struct descriptor
|
||||
*/
|
||||
public StructDescriptor getParent() {
|
||||
return m_parent;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the field name.
|
||||
*
|
||||
* @return field name
|
||||
*/
|
||||
public String getName() {
|
||||
return m_name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the field type.
|
||||
*
|
||||
* @return field type
|
||||
*/
|
||||
public StructFieldType getType() {
|
||||
return m_type;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the field type is a signed integer.
|
||||
*
|
||||
* @return true if signed integer, false otherwise
|
||||
*/
|
||||
public boolean isInt() {
|
||||
return m_type.isInt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the field type is an unsigned integer.
|
||||
*
|
||||
* @return true if unsigned integer, false otherwise
|
||||
*/
|
||||
public boolean isUint() {
|
||||
return m_type.isUint;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the underlying storage size of the field, in bytes.
|
||||
*
|
||||
* @return number of bytes
|
||||
*/
|
||||
public int getSize() {
|
||||
return m_size;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the storage offset of the field, in bytes.
|
||||
*
|
||||
* @return number of bytes from the start of the struct
|
||||
*/
|
||||
public int getOffset() {
|
||||
return m_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the bit width of the field, in bits.
|
||||
*
|
||||
* @return number of bits
|
||||
*/
|
||||
public int getBitWidth() {
|
||||
return m_bitWidth == 0 ? m_size * 8 : m_bitWidth;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the bit mask for the field. The mask is always the least significant bits (it is not
|
||||
* shifted).
|
||||
*
|
||||
* @return bit mask
|
||||
*/
|
||||
public long getBitMask() {
|
||||
return m_bitMask;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the bit shift for the field (LSB=0).
|
||||
*
|
||||
* @return number of bits
|
||||
*/
|
||||
public int getBitShift() {
|
||||
return m_bitShift;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the field is an array.
|
||||
*
|
||||
* @return true if array
|
||||
*/
|
||||
public boolean isArray() {
|
||||
return m_arraySize > 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the array size. Returns 1 if non-array.
|
||||
*
|
||||
* @return number of elements
|
||||
*/
|
||||
public int getArraySize() {
|
||||
return m_arraySize;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the field has enumerated values.
|
||||
*
|
||||
* @return true if there are enumerated values
|
||||
*/
|
||||
public boolean hasEnum() {
|
||||
return m_enum != null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the enumerated values.
|
||||
*
|
||||
* @return set of enumerated values
|
||||
*/
|
||||
public Map<String, Long> getEnumValues() {
|
||||
return m_enum;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the struct descriptor for a struct data type.
|
||||
*
|
||||
* @return struct descriptor; returns null for non-struct
|
||||
*/
|
||||
public StructDescriptor getStruct() {
|
||||
return m_struct;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the minimum unsigned integer value that can be stored in this field.
|
||||
*
|
||||
* @return minimum value
|
||||
*/
|
||||
public long getUintMin() {
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the maximum unsigned integer value that can be stored in this field. Note this is not the
|
||||
* actual maximum for uint64 (due to Java lacking support for 64-bit unsigned integers).
|
||||
*
|
||||
* @return maximum value
|
||||
*/
|
||||
public long getUintMax() {
|
||||
return m_bitMask;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the minimum signed integer value that can be stored in this field.
|
||||
*
|
||||
* @return minimum value
|
||||
*/
|
||||
public long getIntMin() {
|
||||
return (-(m_bitMask >> 1)) - 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the maximum signed integer value that can be stored in this field.
|
||||
*
|
||||
* @return maximum value
|
||||
*/
|
||||
public long getIntMax() {
|
||||
return m_bitMask >> 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the field is a bitfield.
|
||||
*
|
||||
* @return true if bitfield
|
||||
*/
|
||||
public boolean isBitField() {
|
||||
return m_bitShift != 0 || m_bitWidth != (m_size * 8);
|
||||
}
|
||||
|
||||
private final StructDescriptor m_parent;
|
||||
private final String m_name;
|
||||
int m_size;
|
||||
int m_offset;
|
||||
final int m_arraySize; // 1 for non-arrays
|
||||
private final Map<String, Long> m_enum;
|
||||
private final StructDescriptor m_struct; // null for non-structs
|
||||
private final long m_bitMask;
|
||||
private final StructFieldType m_type;
|
||||
private final int m_bitWidth;
|
||||
int m_bitShift;
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct;
|
||||
|
||||
/** Known data types for raw struct dynamic fields (see StructFieldDescriptor). */
|
||||
public enum StructFieldType {
|
||||
kBool("bool", false, false, 1),
|
||||
kChar("char", false, false, 1),
|
||||
kInt8("int8", true, false, 1),
|
||||
kInt16("int16", true, false, 2),
|
||||
kInt32("int32", true, false, 4),
|
||||
kInt64("int64", true, false, 8),
|
||||
kUint8("uint8", false, true, 1),
|
||||
kUint16("uint16", false, true, 2),
|
||||
kUint32("uint32", false, true, 4),
|
||||
kUint64("uint64", false, true, 8),
|
||||
kFloat("float", false, false, 4),
|
||||
kDouble("double", false, false, 8),
|
||||
kStruct("struct", false, false, 0);
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public final String name;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public final boolean isInt;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public final boolean isUint;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public final int size;
|
||||
|
||||
StructFieldType(String name, boolean isInt, boolean isUint, int size) {
|
||||
this.name = name;
|
||||
this.isInt = isInt;
|
||||
this.isUint = isUint;
|
||||
this.size = size;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get field type from string.
|
||||
*
|
||||
* @param str string
|
||||
* @return field type
|
||||
*/
|
||||
public static StructFieldType fromString(String str) {
|
||||
for (StructFieldType type : StructFieldType.values()) {
|
||||
if (type.name.equals(str)) {
|
||||
return type;
|
||||
}
|
||||
}
|
||||
if ("float32".equals(str)) {
|
||||
return kFloat;
|
||||
} else if ("float64".equals(str)) {
|
||||
return kDouble;
|
||||
} else {
|
||||
return kStruct;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,132 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct.parser;
|
||||
|
||||
/** Raw struct schema lexer. */
|
||||
public class Lexer {
|
||||
/**
|
||||
* Construct a raw struct schema lexer.
|
||||
*
|
||||
* @param in schema
|
||||
*/
|
||||
public Lexer(String in) {
|
||||
m_in = in;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the next token.
|
||||
*
|
||||
* @return Token kind; the token text can be retrieved using getTokenText()
|
||||
*/
|
||||
public TokenKind scan() {
|
||||
// skip whitespace
|
||||
do {
|
||||
get();
|
||||
} while (m_current == ' ' || m_current == '\t' || m_current == '\n' || m_current == '\r');
|
||||
m_tokenStart = m_pos - 1;
|
||||
|
||||
switch (m_current) {
|
||||
case '[':
|
||||
return TokenKind.kLeftBracket;
|
||||
case ']':
|
||||
return TokenKind.kRightBracket;
|
||||
case '{':
|
||||
return TokenKind.kLeftBrace;
|
||||
case '}':
|
||||
return TokenKind.kRightBrace;
|
||||
case ':':
|
||||
return TokenKind.kColon;
|
||||
case ';':
|
||||
return TokenKind.kSemicolon;
|
||||
case ',':
|
||||
return TokenKind.kComma;
|
||||
case '=':
|
||||
return TokenKind.kEquals;
|
||||
case '-':
|
||||
case '0':
|
||||
case '1':
|
||||
case '2':
|
||||
case '3':
|
||||
case '4':
|
||||
case '5':
|
||||
case '6':
|
||||
case '7':
|
||||
case '8':
|
||||
case '9':
|
||||
return scanInteger();
|
||||
case '\0':
|
||||
return TokenKind.kEndOfInput;
|
||||
default:
|
||||
if (Character.isLetter(m_current) || m_current == '_') {
|
||||
return scanIdentifier();
|
||||
}
|
||||
return TokenKind.kUnknown;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the text of the last lexed token.
|
||||
*
|
||||
* @return token text
|
||||
*/
|
||||
public String getTokenText() {
|
||||
if (m_tokenStart >= m_in.length()) {
|
||||
return "";
|
||||
}
|
||||
return m_in.substring(m_tokenStart, m_pos);
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the starting position of the last lexed token.
|
||||
*
|
||||
* @return position (0 = first character)
|
||||
*/
|
||||
public int getPosition() {
|
||||
return m_tokenStart;
|
||||
}
|
||||
|
||||
private TokenKind scanInteger() {
|
||||
do {
|
||||
get();
|
||||
} while (Character.isDigit(m_current));
|
||||
unget();
|
||||
return TokenKind.kInteger;
|
||||
}
|
||||
|
||||
private TokenKind scanIdentifier() {
|
||||
do {
|
||||
get();
|
||||
} while (Character.isLetterOrDigit(m_current) || m_current == '_');
|
||||
unget();
|
||||
return TokenKind.kIdentifier;
|
||||
}
|
||||
|
||||
private void get() {
|
||||
if (m_pos < m_in.length()) {
|
||||
m_current = m_in.charAt(m_pos);
|
||||
} else {
|
||||
m_current = '\0';
|
||||
}
|
||||
++m_pos;
|
||||
}
|
||||
|
||||
private void unget() {
|
||||
if (m_pos > 0) {
|
||||
m_pos--;
|
||||
if (m_pos < m_in.length()) {
|
||||
m_current = m_in.charAt(m_pos);
|
||||
} else {
|
||||
m_current = '\0';
|
||||
}
|
||||
} else {
|
||||
m_current = '\0';
|
||||
}
|
||||
}
|
||||
|
||||
final String m_in;
|
||||
char m_current;
|
||||
int m_tokenStart;
|
||||
int m_pos;
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct.parser;
|
||||
|
||||
public class ParseException extends Exception {
|
||||
private final int m_pos;
|
||||
|
||||
public ParseException(int pos, String s) {
|
||||
super(s);
|
||||
m_pos = pos;
|
||||
}
|
||||
|
||||
public ParseException(int pos, String message, Throwable cause) {
|
||||
super(message, cause);
|
||||
m_pos = pos;
|
||||
}
|
||||
|
||||
public ParseException(int pos, Throwable cause) {
|
||||
super(cause);
|
||||
m_pos = pos;
|
||||
}
|
||||
|
||||
public int getPosition() {
|
||||
return m_pos;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return m_pos + ": " + getMessage();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,25 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct.parser;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
/** Raw struct schema declaration. */
|
||||
public class ParsedDeclaration {
|
||||
@SuppressWarnings("MemberName")
|
||||
public String typeString;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public String name;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public Map<String, Long> enumValues;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public int arraySize = 1;
|
||||
|
||||
@SuppressWarnings("MemberName")
|
||||
public int bitWidth;
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct.parser;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
|
||||
/** Raw struct schema. */
|
||||
public class ParsedSchema {
|
||||
@SuppressWarnings("MemberName")
|
||||
public List<ParsedDeclaration> declarations = new ArrayList<>();
|
||||
}
|
||||
@@ -0,0 +1,157 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct.parser;
|
||||
|
||||
import java.util.HashMap;
|
||||
import java.util.Map;
|
||||
|
||||
/** Raw struct schema parser. */
|
||||
public class Parser {
|
||||
/**
|
||||
* Construct a raw struct schema parser.
|
||||
*
|
||||
* @param in schema
|
||||
*/
|
||||
public Parser(String in) {
|
||||
m_lexer = new Lexer(in);
|
||||
}
|
||||
|
||||
/**
|
||||
* Parses the schema.
|
||||
*
|
||||
* @return parsed schema object
|
||||
* @throws ParseException on parse error
|
||||
*/
|
||||
public ParsedSchema parse() throws ParseException {
|
||||
ParsedSchema schema = new ParsedSchema();
|
||||
do {
|
||||
getNextToken();
|
||||
if (m_token == TokenKind.kSemicolon) {
|
||||
continue;
|
||||
}
|
||||
if (m_token == TokenKind.kEndOfInput) {
|
||||
break;
|
||||
}
|
||||
schema.declarations.add(parseDeclaration());
|
||||
} while (m_token != TokenKind.kEndOfInput);
|
||||
return schema;
|
||||
}
|
||||
|
||||
private ParsedDeclaration parseDeclaration() throws ParseException {
|
||||
ParsedDeclaration decl = new ParsedDeclaration();
|
||||
|
||||
// optional enum specification
|
||||
if (m_token == TokenKind.kIdentifier && "enum".equals(m_lexer.getTokenText())) {
|
||||
getNextToken();
|
||||
expect(TokenKind.kLeftBrace);
|
||||
decl.enumValues = parseEnum();
|
||||
getNextToken();
|
||||
} else if (m_token == TokenKind.kLeftBrace) {
|
||||
decl.enumValues = parseEnum();
|
||||
getNextToken();
|
||||
}
|
||||
|
||||
// type name
|
||||
expect(TokenKind.kIdentifier);
|
||||
decl.typeString = m_lexer.getTokenText();
|
||||
getNextToken();
|
||||
|
||||
// identifier name
|
||||
expect(TokenKind.kIdentifier);
|
||||
decl.name = m_lexer.getTokenText();
|
||||
getNextToken();
|
||||
|
||||
// array or bit field
|
||||
if (m_token == TokenKind.kLeftBracket) {
|
||||
getNextToken();
|
||||
expect(TokenKind.kInteger);
|
||||
String valueStr = m_lexer.getTokenText();
|
||||
int value;
|
||||
try {
|
||||
value = Integer.parseInt(valueStr);
|
||||
} catch (NumberFormatException e) {
|
||||
value = 0;
|
||||
}
|
||||
if (value > 0) {
|
||||
decl.arraySize = value;
|
||||
} else {
|
||||
throw new ParseException(
|
||||
m_lexer.m_pos, "array size '" + valueStr + "' is not a positive integer");
|
||||
}
|
||||
getNextToken();
|
||||
expect(TokenKind.kRightBracket);
|
||||
getNextToken();
|
||||
} else if (m_token == TokenKind.kColon) {
|
||||
getNextToken();
|
||||
expect(TokenKind.kInteger);
|
||||
String valueStr = m_lexer.getTokenText();
|
||||
int value;
|
||||
try {
|
||||
value = Integer.parseInt(valueStr);
|
||||
} catch (NumberFormatException e) {
|
||||
value = 0;
|
||||
}
|
||||
if (value > 0) {
|
||||
decl.bitWidth = value;
|
||||
} else {
|
||||
throw new ParseException(
|
||||
m_lexer.m_pos, "bitfield width '" + valueStr + "' is not a positive integer");
|
||||
}
|
||||
getNextToken();
|
||||
}
|
||||
|
||||
// declaration must end with EOF or semicolon
|
||||
if (m_token != TokenKind.kEndOfInput) {
|
||||
expect(TokenKind.kSemicolon);
|
||||
}
|
||||
|
||||
return decl;
|
||||
}
|
||||
|
||||
private Map<String, Long> parseEnum() throws ParseException {
|
||||
Map<String, Long> map = new HashMap<>();
|
||||
|
||||
// we start with current = '{'
|
||||
getNextToken();
|
||||
while (m_token != TokenKind.kRightBrace) {
|
||||
expect(TokenKind.kIdentifier);
|
||||
final String name = m_lexer.getTokenText();
|
||||
getNextToken();
|
||||
expect(TokenKind.kEquals);
|
||||
getNextToken();
|
||||
expect(TokenKind.kInteger);
|
||||
String valueStr = m_lexer.getTokenText();
|
||||
long value;
|
||||
try {
|
||||
value = Long.parseLong(valueStr);
|
||||
} catch (NumberFormatException e) {
|
||||
throw new ParseException(m_lexer.m_pos, "could not parse enum value '" + valueStr + "'");
|
||||
}
|
||||
map.put(name, value);
|
||||
getNextToken();
|
||||
if (m_token == TokenKind.kRightBrace) {
|
||||
break;
|
||||
}
|
||||
expect(TokenKind.kComma);
|
||||
getNextToken();
|
||||
}
|
||||
return map;
|
||||
}
|
||||
|
||||
private TokenKind getNextToken() {
|
||||
m_token = m_lexer.scan();
|
||||
return m_token;
|
||||
}
|
||||
|
||||
private void expect(TokenKind kind) throws ParseException {
|
||||
if (m_token != kind) {
|
||||
throw new ParseException(
|
||||
m_lexer.m_pos, "expected " + kind + ", got '" + m_lexer.getTokenText() + "'");
|
||||
}
|
||||
}
|
||||
|
||||
final Lexer m_lexer;
|
||||
TokenKind m_token;
|
||||
}
|
||||
@@ -0,0 +1,32 @@
|
||||
// Copyright (c) FIRST and other WPILib contributors.
|
||||
// Open Source Software; you can modify and/or share it under the terms of
|
||||
// the WPILib BSD license file in the root directory of this project.
|
||||
|
||||
package edu.wpi.first.util.struct.parser;
|
||||
|
||||
/** A lexed raw struct schema token. */
|
||||
public enum TokenKind {
|
||||
kUnknown("unknown"),
|
||||
kInteger("integer"),
|
||||
kIdentifier("identifier"),
|
||||
kLeftBracket("'['"),
|
||||
kRightBracket("']'"),
|
||||
kLeftBrace("'{'"),
|
||||
kRightBrace("'}'"),
|
||||
kColon("':'"),
|
||||
kSemicolon("';'"),
|
||||
kComma("','"),
|
||||
kEquals("'='"),
|
||||
kEndOfInput("<EOF>");
|
||||
|
||||
private final String m_name;
|
||||
|
||||
TokenKind(String name) {
|
||||
this.m_name = name;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return m_name;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user