collapseChunkPlugin (generic code) works for msort

Author: lee-naish

src/algorithms/controllers/collapseChunkPlugin.js

@@ -0,0 +1,68 @@
+// Stuff to access what chunks are collapsed, so animation can depend on
+// that (eg show less/more information). There was an accumulation
+// of different versions of this for different algorithms. This is a
+// more generic one that requires some extra some code in algorithm files.
+// Possibly should be put elsewhere, eg, src/context/
+// NOTE: any algorithm controller file that imports this must be listed
+// below, otherwise hooks into what happens when blocks are expanded or
+// contracted are not enabled.
+const importsThis = ['quickSort', 'quickSortM3', 'msort_arr_td', 'transitiveClosure'];
+
+// eslint-disable-next-line import/no-cycle
+// See also accompanying mods/hooks in src/context/GlobalState.js and
+// src/context/actions.js 
+import { GlobalActions } from '../../context/actions';
+
+let algorithmGetter = () => null;
+
+function getGlobalAlgorithm() {
+  return algorithmGetter();
+}
+
+window.getGlobalAlgorithm = getGlobalAlgorithm;
+export function initGlobalAlgorithmGetter(getter) {
+  algorithmGetter = getter;
+}
+
+// Checks if list of pseudocode blocks are all currently expanded.  Note
+// that "inner" blocks can be expanded even when "outer" ones are not, eg,
+// for msort_arr_td has block Merge inside MergeCopy.  To check if Merge
+// code is visible (so certain variables should be displayed), we should
+// check both Merge and MergeCopy are expanded.  Hopefully, using a list
+// of blocks in this interface will help remind programmers to include the
+// block we are interested in *plus enclosing blocks* (Main is always
+// expanded so that is not needed).
+export function areExpanded(Blocks) {
+  const algorithm = getGlobalAlgorithm();
+  const alg_name = algorithm.id.name;
+  const { bookmark, pseudocode, collapse } = algorithm;
+  return Blocks.reduce((acc, curr) =>
+     (acc && collapse[alg_name.sort][curr]), true);
+}
+
+// Trigger refresh of display when code is expanded/collapsed.
+// Not so efficient - runs through all the chunks from the start. XXX
+// However, it seems to work fine and is pretty general. We could
+// possibly add a shortcut for algorithms that never change display
+// depending on what blocks are collapsed. XXX
+export function onCollapseChange(chunker) {
+  // const algorithm = getGlobalAlgorithm();
+  chunker.refresh();
+}
+
+
+/////////////////////////////////////////////////////
+
+export function isMergeCopyExpanded() {
+  return areExpanded(['MergeCopy']);
+}
+
+export function isMergeExpanded() {
+  return areExpanded(['MergeCopy', 'Merge']);
+}
+
+// checks if either recursive call is expanded (needed to determine if i
+// should be displayed)
+export function isRecursionExpanded() {
+  return areExpanded(['MergesortL']) || areExpanded(['MergesortR']);
+}

src/algorithms/controllers/msort_arr_td.js

@@ -46,10 +46,12 @@ export default {
 import ArrayTracer from '../../components/DataStructures/Array/Array1DTracer';
 
 import {
+  // XXX may not need isMergeExpanded? only needed if last chunk of
+  // merge still as extra vars displayed
   isMergeExpanded,
   isMergeCopyExpanded,
   isRecursionExpanded,
-} from './msort_arr_tdCollapseChunkPlugin';
+} from './collapseChunkPlugin';
 
 // MergeExpandedR true if Merge code is really/recursively expanded (ie,
 // visible in animation).  Its possible for Merge to be expanded but the

src/algorithms/controllers/quickSortCollapseChunkPlugin.js

@@ -72,7 +72,4 @@ export function onCollapseStateChangeQS(chunker) {
   if (!isInQuickSort()) return false;
   const algorithm = getGlobalAlgorithm();
   chunker.refresh();
-  // XX re-runs algorithm from start - Not what we want
-  //triggerButtonClick();
-  //GlobalActions.RUN_ALGORITHM(algorithm.state, algorithm.id);
 }

src/context/GlobalState.js

@@ -1,4 +1,7 @@
 import React, { createContext, useState } from 'react';
+// generic version of collapseChunkPlugin - could probably adapt code and
+// delete some others XXX
+import { initGlobalAlgorithmGetter } from '../algorithms/controllers/collapseChunkPlugin';
 import { initGlobalAlgotithmGetter } from '../algorithms/controllers/transitiveClosureCollapseChunkPlugin';
 import { initGlobalAlgorithmGetterQS } from '../algorithms/controllers/quickSortCollapseChunkPlugin';
 import { initGlobalAlgorithmGettermsort_arr_td } from '../algorithms/controllers/msort_arr_tdCollapseChunkPlugin';
@@ -35,7 +38,6 @@ export const GlobalProvider = ({ children }) => {
 
   initGlobalAlgotithmGetter(
     () => globalState.algorithm,
-    () => dispatch,
   );
   initGlobalAlgorithmGetterQS(
     () => globalState.algorithm,

src/context/actions.js

@@ -4,6 +4,9 @@
 import algorithms from '../algorithms';
 import Chunker from './chunker';
 import findBookmark from '../pseudocode/findBookmark';
+// generic version of collapseChunkPlugin - could probably adapt code and
+// delete some others XXX
+import { onCollapseChange } from '../algorithms/controllers/collapseChunkPlugin';
 import { onCollapseStateChange } from '../algorithms/controllers/transitiveClosureCollapseChunkPlugin';
 import { onCollapseStateChangeQS } from '../algorithms/controllers/quickSortCollapseChunkPlugin';
 import { onCollapseStateChangemsort_arr_td } from '../algorithms/controllers/msort_arr_tdCollapseChunkPlugin';