Magic Cube

///////////////////////////////////////////////////////////////////////////////////////////////////

// Copyright 2020 Leszek Koltunski                                                               //

//                                                                                               //

// This file is part of Magic Cube.                                                              //

//                                                                                               //

// Magic Cube is free software: you can redistribute it and/or modify                            //

// it under the terms of the GNU General Public License as published by                          //

// the Free Software Foundation, either version 2 of the License, or                             //

// (at your option) any later version.                                                           //

//                                                                                               //

// Magic Cube is distributed in the hope that it will be useful,                                 //

// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //

// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //

// GNU General Public License for more details.                                                  //

//                                                                                               //

// You should have received a copy of the GNU General Public License                             //

// along with Magic Cube.  If not, see <http://www.gnu.org/licenses/>.                           //

///////////////////////////////////////////////////////////////////////////////////////////////////

package org.distorted.patterns;

import java.util.Vector;

///////////////////////////////////////////////////////////////////////////////////////////////////

public class RubikPattern

{

  public static final int MIN_CUBE  = 2;

  public static final int MAX_CUBE  = 5;

  public static final int NUM_CUBES = MAX_CUBE-MIN_CUBE+1;

  private int[] numCategories   = new int[NUM_CUBES];

  private int[] currentCategory = new int[NUM_CUBES];

  private Vector<Category>[] mCategories;

  private static RubikPattern mThis;

///////////////////////////////////////////////////////////////////////////////////////////////////

  private static class Category

    {

    private String name;

    private int numPatterns;

    private Vector<Pattern> patterns;

  /////////////////////////////////////////////////////////////

    Category(String n)

      {

      name=n;

      numPatterns=0;

      patterns = new Vector<>();

      }

  /////////////////////////////////////////////////////////////

    void addPattern(Pattern p)

      {

      patterns.addElement(p);

      numPatterns++;

      }

  /////////////////////////////////////////////////////////////

    int getNumPatterns()

    {

    return numPatterns;

    }

  /////////////////////////////////////////////////////////////

    String getName()

    {

    return name;

    }

  /////////////////////////////////////////////////////////////

    String getPatternName(int pattern)

      {

      if( pattern>=0 && pattern<numPatterns )

        {

        Pattern p = patterns.elementAt(pattern);

        return  p!=null ? p.getName():"";

        }

      return "";

      }

  /////////////////////////////////////////////////////////////

    int getPatternCurMove(int pattern)

      {

      if( pattern>=0 && pattern<numPatterns )

        {

        Pattern p = patterns.elementAt(pattern);

        return  p!=null ? p.getCurMove():-1;

        }

      return -1;

      }

  /////////////////////////////////////////////////////////////

    int getPatternNumMove(int pattern)

      {

      if( pattern>=0 && pattern<numPatterns )

        {

        Pattern p = patterns.elementAt(pattern);

        return  p!=null ? p.getNumMove():-1;

        }

      return -1;

      }

  /////////////////////////////////////////////////////////////

    String retInitializationString(int pattern)

      {

      if( pattern>=0 && pattern<numPatterns )

        {

        Pattern p = patterns.elementAt(pattern);

        if( p!=null ) return p.retInitializationString();

        }

      return "";

      }

  /////////////////////////////////////////////////////////////

    String retNextMove(int pattern)

      {

      if( pattern>=0 && pattern<numPatterns )

        {

        Pattern p = patterns.elementAt(pattern);

        if( p!=null ) return p.retNextMove();

        }

      return "";

      }

  /////////////////////////////////////////////////////////////

    String retPrevMove(int pattern)

      {

      if( pattern>=0 && pattern<numPatterns )

        {

        Pattern p = patterns.elementAt(pattern);

        if( p!=null ) return p.retPrevMove();

        }

      return "";

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private static class Pattern

    {

    private String name;

    private String moves;

    private int curMove;

    private int numMove;

  /////////////////////////////////////////////////////////////

    Pattern(String n, String m)

      {

      name=n;

      moves=m;

      numMove = moves.length()/4;

      curMove=numMove;

      }

  /////////////////////////////////////////////////////////////

    String getName()

      {

      return name;

      }

  /////////////////////////////////////////////////////////////

    int getNumMove()

    {

    return numMove;

    }

  /////////////////////////////////////////////////////////////

    int getCurMove()

    {

    return curMove;

    }

  /////////////////////////////////////////////////////////////

    String retNextMove()

      {

      curMove++;

      if( curMove>numMove)

        {

        curMove= 0;

        return retInitializationString();

        }

      else

        {

        curMove--;

        return moves.substring(4*curMove-4,4*curMove);

        }

      }

  /////////////////////////////////////////////////////////////

    String retPrevMove()

      {

      curMove--;

      if( curMove<0)

        {

        curMove=numMove;

        return retInitializationString();

        }

      else

        {

        curMove++;

        return moves.substring(4*curMove,4*curMove+4);

        }

      }

  /////////////////////////////////////////////////////////////

    String retInitializationString()

      {

      return moves.substring(0,4*curMove);

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private RubikPattern()

    {

    mCategories = new Vector[NUM_CUBES];

    initializeCategories(0, RubikPatternData2.patterns);

    initializeCategories(1, RubikPatternData3.patterns);

    initializeCategories(2, RubikPatternData4.patterns);

    initializeCategories(3, RubikPatternData5.patterns);

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  private void initializeCategories(int num, String[] pat)

    {

    int colon;

    mCategories[num] = new Vector<>();

    Category cat=null;

    String name, pattern;

    Pattern patt;

    numCategories[num]=0;

    for(String p: pat)

      {

      colon = p.indexOf(':');

      if( colon==-1 )

        {

        cat = new Category(p);

        mCategories[num].addElement(cat);

        numCategories[num]++;

        }

      else

        {

        pattern = p.substring(colon+1);

        name    = p.substring(0,colon);

        patt = new Pattern(name,pattern);

        cat.addPattern(patt);

        }

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

// PUBLIC API

///////////////////////////////////////////////////////////////////////////////////////////////////

  public static RubikPattern getInstance()

    {

    if( mThis==null )

      {

      mThis = new RubikPattern();

      }

    return mThis;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int getNumCategories(int size)

    {

    return size>=0 && size<NUM_CUBES ? numCategories[size] : 0;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public String getCategoryName(int size,int num)

    {

    if( size>=0 && size<NUM_CUBES && num>=0 && num< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(num);

      return c!=null ? c.getName() : null;

      }

    return null;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public void rememberCategory(int size,int num)

    {

    if( size>=0 && size<NUM_CUBES )

      {

      currentCategory[size] = num;

      }

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int recallCategory(int size)

    {

    return size>=0 && size<NUM_CUBES ? currentCategory[size] : 0;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public String getPatternName(int size, int cat, int pat)

    {

    if( size>=0 && size<NUM_CUBES && cat>=0 && cat< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(cat);

      return c!=null ? c.getPatternName(pat) : null;

      }

    return null;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int getNumPatterns(int size, int num )

    {

    if( size>=0 && size<NUM_CUBES && num>=0 && num< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(num);

      return c!=null ? c.getNumPatterns() : 0;

      }

    return 0;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int getCurMove(int size, int cat, int pat)

    {

    if( size>=0 && size<NUM_CUBES && cat>=0 && cat< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(cat);

      return c!=null ? c.getPatternCurMove(pat):0;

      }

    return 0;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public int getNumMoves(int size, int cat, int pat)

    {

    if( size>=0 && size<NUM_CUBES && cat>=0 && cat< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(cat);

      return c!=null ? c.getPatternNumMove(pat):0;

      }

    return 0;

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public String retNextMove(int size, int cat, int pat)

    {

    if( size>=0 && size<NUM_CUBES && cat>=0 && cat< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(cat);

      if( c!=null ) return c.retNextMove(pat);

      }

    return "";

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public String retPrevMove(int size, int cat, int pat)

    {

    if( size>=0 && size<NUM_CUBES && cat>=0 && cat< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(cat);

      if( c!=null ) return c.retPrevMove(pat);

      }

    return "";

    }

///////////////////////////////////////////////////////////////////////////////////////////////////

  public String retInitializationString(int size,int cat, int pat)

    {

    if( size>=0 && size<NUM_CUBES && cat>=0 && cat< numCategories[size] )

      {

      Category c = mCategories[size].elementAt(cat);

      if( c!=null ) return c.retInitializationString(pat);

      }

    return "";

    }

}