widgets/bitstring.js

  1. /*
  2.  * This file is part of AUX.
  3.  *
  4.  * AUX is free software; you can redistribute it and/or
  5.  * modify it under the terms of the GNU General Public
  6.  * License as published by the Free Software Foundation; either
  7.  * version 3 of the License, or (at your option) any later version.
  8.  *
  9.  * AUX is distributed in the hope that it will be useful,
  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  12.  * General Public License for more details.
  13.  *
  14.  * You should have received a copy of the GNU General
  15.  * Public License along with this program; if not, write to the
  16.  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17.  * Boston, MA  02110-1301  USA
  18.  */
  20. import { addClass } from './../utils/dom.js';
  21. import { Buttons } from './buttons.js';
  22. import { error } from '../utils/log.js';
  24. /**
  25.  * The <code>useraction</code> event is emitted when a widget gets modified by user interaction.
  26.  * The event is emitted for the option <code>select</code>.
  27.  *
  28.  * @event Buttons#useraction
  29.  * @param {string} name - The name of the option which was changed due to the users action
  30.  * @param {mixed} value - The new value of the option
  31.  */
  33. /**
  34.  * Bitstring is a specialized ({@link Buttons}) widget to display and
  35.  * control arrays of bits.
  36.  *
  37.  * @param {Object} [options={ }] - An object containing initial options.
  38.  *
  39.  * @property {Function} [options.labels="i => i + 1"] - A function receiving
  40.  *   the index as argument to format the buttons labels if the buttons
  41.  *   are set as `options.length` and not as `options.buttons`.
  42.  * @property {Function} [options.icons="i => null"] - A function receiving
  43.  *   the index as argument to format the buttons labels if the buttons
  44.  *   are set as `options.length` and not as `options.buttons`.
  45.  * @property {Number|Boolean} [options.length=false] - The length of the bitstring.
  46.  *   Use this option to auto-generate the buttons. If you want to have more
  47.  *   control over the buttons displayed, set them as `options.buttons`
  48.  *   and set this option to `false`.
  49.  *
  50.  * @class Bitstring
  51.  *
  52.  * @extends Buttons
  53.  *
  54.  */
  55. export class Bitstring extends Buttons {
  56.   static get _options() {
  57.     return {
  58.       labels: 'function',
  59.       icons: 'function',
  60.       length: 'number|boolean',
  61.       bitstring: 'array|number',
  62.     };
  63.   }
  65.   static get options() {
  66.     return {
  67.       multi_select: 1,
  68.       labels: (i) => i + 1,
  69.       icons: (i) => null,
  70.       length: false,
  71.       bitstring: 0,
  72.       deselect: true,
  73.     };
  74.   }
  76.   static get static_events() {
  77.     return {
  78.       set_buttons: function (buttons) {
  79.         this.set('bitstring', this.options.bitstring);
  80.       },
  81.       set_length: function (length) {
  82.         if (length !== false) {
  83.           const O = this.options;
  84.           const B = [];
  85.           for (let i = 0, m = length; i < m; ++i) {
  86.             B.push({
  87.               label: O.labels(i),
  88.               icons: O.icons(i),
  89.             });
  90.           }
  91.           this.set('buttons', B);
  92.         }
  93.       },
  94.       set_bitstring: function (bitstring) {
  95.         if (typeof bitstring === 'undefined') return;
  96.         let select;
  97.         if (typeof bitstring === 'number') {
  98.           select = this.buttons.list.map((b, i) =>
  99.             bitstring & (1 << i) ? i : null
  100.           );
  101.         } else if (Array.isArray(bitstring)) {
  102.           select = this.buttons.list.map((b, i) => (bitstring[i] ? i : null));
  103.         } else {
  104.           error('Bitstring %O is not of type number or array.', bitstring);
  105.         }
  106.         if (select) {
  107.           select = select.filter((v) => v !== null);
  108.           this.set('select', select);
  109.         }
  110.       },
  111.       useraction: function (key, value) {
  112.         if (key != 'select') return;
  113.         const O = this.options;
  114.         if (typeof O.bitstring === 'number') {
  115.           let bitstring = 0;
  116.           for (let i = 0, m = value.length; i < m; ++i) {
  117.             if (value[i] === null) continue;
  118.             bitstring |= 1 << value[i];
  119.           }
  120.           this.userset('bitstring', bitstring);
  121.         } else if (Array.isArray(O.bitstring)) {
  122.           const bitstring = new Array(this.buttons.list.length).fill(false);
  123.           value.map((v, i) => (v === null ? null : (bitstring[v] = true)));
  124.           this.userset('bitstring', bitstring);
  125.         } else {
  126.           error('Bitstring %O is not of type number or array.', O.bitstring);
  127.         }
  128.       },
  129.     };
  130.   }
  132.   initialize(options) {
  133.     super.initialize(options);
  134.     /**
  135.      * @member {HTMLDivElement} Bitstring#element - The main DIV container.
  136.      *   Has class <code>.aux-bitstring</code>.
  137.      */
  138.   }
  140.   draw(O, element) {
  141.     addClass(element, 'aux-bitstring');
  143.     this.set('length', O.length);
  144.     this.set('bitstring', O.bitstring);
  146.     super.draw(O, element);
  147.   }
  148. }