Magic Cube

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

// Copyright 2021 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.objects;

import java.util.ArrayList;

import android.content.SharedPreferences;

import org.distorted.main.RubikActivity;

import org.distorted.objectlib.main.ObjectConstants;

import org.distorted.objectlib.main.ObjectType;

import org.distorted.screens.RubikScreenPlay;

import org.distorted.screens.ScreenList;

import static org.distorted.objectlib.main.TwistyObject.MESH_NICE;

import static org.distorted.objectlib.main.ObjectType.NUM_OBJECTS;

import static org.distorted.main.RubikActivity.SHOW_DOWNLOADED_DEBUG;

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

public class RubikObjectList

{

  public static final int DEF_OBJECT= ObjectConstants.CUBE_3;

  public static int MAX_LEVEL;

  private static RubikObjectList mThis;

  private static int mNumObjects;

  private static int mNumExtras;

  private static ArrayList<RubikObject> mObjects;

  private static int mObject = DEF_OBJECT;

  public static class DownloadedObject

    {

    String shortName;

    boolean icon,object,extras;

    int numScrambles, objectMinor, extrasMinor;

    DownloadedObject(String sName, int scrambles, int oMinor, int eMinor, boolean i, boolean o, boolean e)

      {

      shortName = sName;

      numScrambles= scrambles;

      objectMinor = oMinor;

      extrasMinor = eMinor;

      icon   = i;

      object = o;

      extras = e;

      }

    }

  private static ArrayList<DownloadedObject> mDownloadedObjects;

  static

    {

    int max = Integer.MIN_VALUE;

    for (int i=0; i<NUM_OBJECTS; i++)

      {

      int cur = getDBLevel(i);

      if( cur>max ) max = cur;

      }

    MAX_LEVEL = max;

    }

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

  private RubikObjectList()

    {

    mNumObjects= 0;

    mNumExtras = 0;

    mObjects           = new ArrayList<>();

    mDownloadedObjects = new ArrayList<>();

    createBuiltinObjects();

    }

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

  private void createBuiltinObjects()

    {

    for(int i=0; i<NUM_OBJECTS; i++)

      {

      ObjectType type = ObjectType.getObject(i);

      RubikObject obj = new RubikObject(type);

      mObjects.add(obj);

      mNumObjects++;

      if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "creating local object "+type.name() );

      if( obj.hasExtras() )

        {

        if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "has extras "+mNumExtras );

        obj.setExtrasOrdinal(mNumExtras);

        mNumExtras++;

        }

      else

        {

        if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "no extras");

        }

      }

    }

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

  private static boolean internalAddDownloadedObject(DownloadedObject object)

    {

    String name = object.shortName;

    for(RubikObject ro : mObjects )

      if( ro.getLowerName().equals(name) )

        {

        return ro.updateObject(object);

        }

    RubikObject obj = new RubikObject(object);

    mObjects.add(obj);

    mNumObjects++;

    if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "creating downloaded object "+obj.getUpperName() );

    if( obj.hasExtras() )

      {

      if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "has extras "+mNumExtras );

      obj.setExtrasOrdinal(mNumExtras);

      mNumExtras++;

      }

    else

      {

      if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "no extras");

      }

    return true;

    }

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

// PUBLIC API

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

// historically older versions of the app had lower 'maxScrambles' in case of several objects and

// those got remembered in the server-side DB already, so we need to keep using them. This function

// provides a map between 'maxScramble' of an object and its 'dbLevel'. All new objects will have

// those two values the same.

  public static int getDBLevel(int ordinal)

    {

    if( ordinal==ObjectConstants.CUBE_3 ) return 16;

    if( ordinal==ObjectConstants.CUBE_4 ) return 20;

    if( ordinal==ObjectConstants.CUBE_5 ) return 24;

    if( ordinal==ObjectConstants.PYRA_4 ) return 15;

    if( ordinal==ObjectConstants.PYRA_5 ) return 20;

    if( ordinal==ObjectConstants.MEGA_5 ) return 35;

    if( ordinal==ObjectConstants.DIAM_2 ) return 10;

    if( ordinal==ObjectConstants.DIAM_3 ) return 18;

    if( ordinal==ObjectConstants.REDI_3 ) return 14;

    if( ordinal==ObjectConstants.HELI_3 ) return 18;

    if( ordinal==ObjectConstants.SKEW_3 ) return 17;

    if( ordinal==ObjectConstants.REX_3  ) return 16;

    if( ordinal==ObjectConstants.MIRR_3 ) return 16;

    // in 1.9.6 & 1.9.7 there is a bug with downloadable objects (in this very function!):

    // All of those have DBLevel equal to CUBE_3's DBlevel (in 1.9.7!), i.e. 17.

    // This will be a problem when we release a new version of the app which has some of the

    // previously downloadable objects built-in. Thus: in case of those, we need to keep using

    // 17.

    if( ObjectType.wasDownloadableButNowIsBuiltIn(ordinal) )

      {

      return 17;

      }

    return ObjectType.getObject(ordinal).getNumScramble();

    }

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

  public static void addDownloadedObject(String shortName, int numScrambles, int objectMinor, int extrasMinor,

                                         boolean icon, boolean object, boolean extras)

    {

    if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "New downloaded object "+shortName+" icon="+icon+" object="+object+" extras="+extras);

    for( DownloadedObject obj : mDownloadedObjects )

      {

      if( obj.shortName.equals(shortName) )

        {

        obj.icon  |= icon;

        obj.object|= object;

        obj.extras|= extras;

        if( !obj.object ) objectMinor=-1;

        if( !obj.extras ) extrasMinor=-1;

        obj.objectMinor = objectMinor;

        obj.extrasMinor = extrasMinor;

        if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "Updating downloaded object "+shortName+" icon="+obj.icon+" object="+obj.object+" extras="+obj.extras);

        return;

        }

      }

    if( !object ) objectMinor=-1;

    if( !extras ) extrasMinor=-1;

    DownloadedObject obj = new DownloadedObject(shortName,numScrambles,objectMinor,extrasMinor,icon,object,extras);

    if ( internalAddDownloadedObject(obj) )

      {

      if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "Adding new downloaded object "+shortName+" icon="+obj.icon+" object="+obj.object+" extras="+obj.extras);

      mDownloadedObjects.add(obj);

      }

    }

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

  public static void setMeshState(int ordinal, int state)

    {

    if( ordinal>=0 && ordinal<mNumObjects ) mObjects.get(ordinal).setMeshState(state);

    }

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

  public static int getMeshState(int ordinal)

    {

    return (ordinal>=0 && ordinal<mNumObjects) ? mObjects.get(ordinal).getMeshState() : MESH_NICE;

    }

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

  public static void savePreferences(SharedPreferences.Editor editor)

    {

    RubikObject obj = getObject(mObject);

    if( obj!=null ) editor.putString("rol_objName", obj.getUpperName() );

    int numDownloaded = mDownloadedObjects.size();

    if( numDownloaded>0 )

      {

      StringBuilder downloadedObjects = new StringBuilder();

      for(int i=0; i<numDownloaded; i++)

        {

        if( i>0 ) downloadedObjects.append(',');

        DownloadedObject object = mDownloadedObjects.get(i);

        downloadedObjects.append(object.shortName);

        downloadedObjects.append(' ');

        downloadedObjects.append(object.numScrambles);

        downloadedObjects.append(' ');

        downloadedObjects.append(object.objectMinor);

        downloadedObjects.append(' ');

        downloadedObjects.append(object.extrasMinor);

        downloadedObjects.append(' ');

        downloadedObjects.append(object.icon   ? "1":"0");

        downloadedObjects.append(' ');

        downloadedObjects.append(object.object ? "1":"0");

        downloadedObjects.append(' ');

        downloadedObjects.append(object.extras ? "1":"0");

        }

      String objects = downloadedObjects.toString();

      if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", "saving: "+objects);

      editor.putString("rol_downloaded", objects );

      }

    }

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

  public static void saveMeshState(SharedPreferences.Editor editor)

    {

    for(int i=0; i<mNumObjects; i++)

      {

      RubikObject obj = getObject(i);

      if( obj!=null )

        {

        String name = obj.getUpperName();

        editor.putInt("rol_"+name, obj.getMeshState() );

        }

      }

    }

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

  public static void restorePreferences(SharedPreferences preferences)

    {

    if( mThis==null ) mThis = new RubikObjectList();

    String downloaded = preferences.getString("rol_downloaded","");

    if( SHOW_DOWNLOADED_DEBUG ) android.util.Log.e("D", downloaded);

    if( !downloaded.equals(""))

      {

      String[] dObjects = downloaded.split(",");

      for(String dObj : dObjects)

        {

        String[] parts = dObj.split(" ");

        if( parts.length==7 )

          {

          String name = parts[0];

          String scra = parts[1];

          String objM = parts[2];

          String extM = parts[3];

          String icon = parts[4];

          String obje = parts[5];

          String extr = parts[6];

          int scrambles = Integer.parseInt(scra);

          int oMinor    = Integer.parseInt(objM);

          int eMinor    = Integer.parseInt(extM);

          boolean bIcon = icon.equals("1");

          boolean bObje = obje.equals("1");

          boolean bExtr = extr.equals("1");

          addDownloadedObject(name,scrambles,oMinor,eMinor,bIcon,bObje,bExtr);

          }

        }

      }

    RubikObject object = getObject(DEF_OBJECT);

    String defName = object==null ? "CUBE_3" : object.getUpperName();

    String objName= preferences.getString("rol_objName",defName);

    mObject = getOrdinal(objName);

    if( mObject<0 || mObject>=mNumObjects ) mObject = DEF_OBJECT;

    }

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

  public static void restoreMeshState(SharedPreferences preferences)

    {

    for(int i=0; i<mNumObjects; i++)

      {

      RubikObject obj = getObject(i);

      if( obj!=null )

        {

        String name  = obj.getUpperName();

        int meshState= preferences.getInt("rol_"+name,MESH_NICE);

        obj.setMeshState(meshState);

        }

      }

    }

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

  public static boolean setCurrObject(RubikActivity act, int ordinal)

    {

    if( mObject!=ordinal )

      {

      mObject = ordinal;

      RubikScreenPlay play = (RubikScreenPlay) ScreenList.PLAY.getScreenClass();

      play.setCurrObject(act);

      return true;

      }

    return false;

    }

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

  public static int getCurrObject()

    {

    return mObject;

    }

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

  public static RubikObject getObject(int ordinal)

    {

    if( mThis==null ) mThis = new RubikObjectList();

    return ordinal>=0 && ordinal<mNumObjects ? mObjects.get(ordinal) : null;

    }

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

  public static int getNumObjects()

    {

    if( mThis==null ) mThis = new RubikObjectList();

    return mNumObjects;

    }

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

  public static int getOrdinal(String name)

    {

    if( mThis==null ) mThis = new RubikObjectList();

    String lowerName = name.toLowerCase();

    for(int i=0; i<mNumObjects; i++)

      {

      RubikObject obj = mObjects.get(i);

      if( obj.getLowerName().equals(lowerName) ) return i;

      }

    return -1;

    }

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

  public static int getNumExtrasObjects()

    {

    return mNumExtras;

    }

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

  public static int getNumTutorialObjects()

    {

    return mNumExtras;

    }

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

  public static int getObjectOrdinal(int extrasOrdinal)

    {

    for(int i=extrasOrdinal; i<mNumObjects; i++)

      {

      RubikObject object = getObject(i);

      int extOrd = object!=null ? object.getExtrasOrdinal() : -1;

      if( extOrd==extrasOrdinal ) return i;

      }

    return -1;

    }

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

  public static int getExtrasOrdinal(int objectOrdinal)

    {

    RubikObject object = getObject(objectOrdinal);

    return object!=null ? object.getExtrasOrdinal() : -1;

    }

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

  public static int getTutorialOrdinal(int objectOrdinal)

    {

    RubikObject object = getObject(objectOrdinal);

    return object!=null ? object.getExtrasOrdinal() : -1;

    }

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

  public static int getLocalObjectMinor(int objectOrdinal)

    {

    RubikObject object = getObject(objectOrdinal);

    return object!=null ? object.getObjectMinor() : -1;

    }

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

  public static int getLocalExtrasMinor(int objectOrdinal)

    {

    RubikObject object = getObject(objectOrdinal);

    return object!=null ? object.getExtrasMinor() : -1;

    }

}