Robotics Service Bus » RSBag

Use access protocol in src/filter/*.lisp

refs #2527

Added "opt-in" methods for filter classes on the access? generic
function, i.e. these methods return true if the filter in question has
to read the a given event part.

• src/filter/filter-mixins.lisp (header): updated copyright
  (access? payload-matching-mixin eql :data eql :read): new method;
  return t
• src/filter/composite-filter.lisp (header): updated copyright
  (access? composite-filter t t): new method; delegate decision to
  children
• src/filter/meta-data-filter.lisp (header): updated copyright
  (access? meta-data-filter eql :meta-data eql :read): new method;
  return t
• src/filter/method-filter.lisp (header): updated copyright
  (access? method-filter eql :method eql :read): new method; return t
• src/filter/origin-filter.lisp (header): updated copyright
  (access? origin-filter eql :origin eql :read): new method; return t
• src/filter/scope-filter.lisp (header): updated copyright
  (access? scope-filter eql :scope eql :read): new method; return t
• src/filter/type-filter.lisp (access? type-filter eql :data eql :read):
  new method; return t
• test/filter/package.lisp (header): updated copyright
  (package rsb.filter.test): added used package let-plus; fixed
  documentation string
  (call-with-filter-checking-thunk): new function; perform a filter
  check with a suitable access checking event
  (define-basic-filter-test-cases): use
  `call-with-filter-checking-thunk'

Implemented access? protocol in src/{formatting,stats}/*.lisp

refs #2527

Event formatting styles, columns and statistical quantities use the
access? protocol to report the event parts they need access to.

• src/formatting/style-mixins.lisp (access-mixin): new class; mixin for
  access declaring style classes
  (access? access-mixin t eql :write): new method; return nil as
  formatting styles never write
  (access? delegating-mixin t t): new method; delegate to sub-styles
  (access? payload-style-mixin eql :data eql :read): new method; return
  true when there is a payload style
• src/formatting/text-style-mixins.lisp (access? columns-mixin t t): new
  method; delegate to columns
• src/formatting/quantity-column.lisp (access? quantity-column t t): new
  method; delegate to quantity
• src/formatting/columns.lisp (define-simple-column): generate methods
  on the `access?' generic function according to the access requirements
  of the column class
• src/formatting/event-style-meta-data.lisp (define-access?-method):
  new local macro; define methods on the `access?' generic
  function (style-meta-data): added superclass `access-mixin'
• src/formatting/event-style-detailed.lisp (style-detailed): added
  superclass `access-mixin'
• src/formatting/timeline.lisp (define-access?-method): local macro;
  define methods on the `access?' generic function
• src/formatting/event-style-json.lisp (style-json): added superclass
  `access-mixin'
  (access? style-json t eql :read): new method; return t as read access
  to all parts is required
• src/formatting/event-style-programmable.lisp
  (style-programmable-default-bindings): minor renaming to make
  binding use detectable
  (style-programmable-default-binding-access-info): new variable;
  stores event parts corresponding to bindings
  (style-programmable::used-bindings): new slot; stores names of
  bindings used by the code
  (setf style-code :before t style-programmable): use local function
  `recompile' which also updates used bindings
  (setf style-bindings :before t style-programmable): likewise
  (access? style-programmable t eql :read): new method; check query
  against used bindings
  (binding-use): new condition class; helper for detecting binding
  during compilation
  (compile-code style-programmable t list): detect binding uses and
  return list of used bindings
• src/stats/quantities.lisp (header): updated copyright
  (define-simple-quantity): generate methods on the `access?' generic
  function according to the access requirements of the quantity class
• test/formatting/package.lisp (header): updated copyright
  (ensure-style-cases): use `with-access-checking' and
  `maybe-add-access-checking' to perform all tests with access checking
  events
  (maybe-add-access-checking): new function; helper for
  `ensure-style-cases'
• cl-rsb-formatting.asd (system cl-rsb-formatting-test): added system
  dependency on cl-rsb-test

Exploit access? protocol in src/commands/cat.lisp

fixes #2527

Using the access? protocol, select a channel transformation that
deserializes event payloads or not depending on whether the selected
event formatting style needs access to event payloads.

• src/commands/util.lisp (header): updated copyright
  (coding-transform): removed; replaced by function
  (coding-transform): new function; return transform specification with
  or without non-trivial converter depending on whether access to the
  event payload is needed
• src/commands/cat.lisp (command-execute cat): determine whether the
  selected formatting style needs access to the event payload and select
  the transform accordingly; adapted to `coding-transform' change
• src/commands/transform.lisp (header): updated copyright
  (command-execute transform): adapted to `coding-transform' change

Account for filter when selecting converters in src/commands/bridge/participant.lisp

refs #2527

• src/commands/bridge/participant.lisp
  (shared-initialize :after connect t): also query filters when
  determining whether read access to the event data will be required