OCCT

// Created on: 2018/03/21
// Created by: Eugeny MALTCHIKOV
// Copyright (c) 2018 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#include <BRepTest.hxx>

#include <BRep_Builder.hxx>

#include <BRepTest_DrawableHistory.hxx>
#include <BRepTest_Objects.hxx>

#include <Draw.hxx>
#include <DBRep.hxx>

#include <TopoDS.hxx>

static int SetFillHistory(Draw_Interpretor&, int, const char**);
static int SaveHistory(Draw_Interpretor&, int, const char**);
static int Modified(Draw_Interpretor&, int, const char**);
static int Generated(Draw_Interpretor&, int, const char**);
static int IsDeleted(Draw_Interpretor&, int, const char**);

//=================================================================================================

void BRepTest::HistoryCommands(Draw_Interpretor& theCommands)
{
  static bool isDone = false;
  if (isDone)
  {
    return;
  }
  isDone = true;
  // Chapter's name
  const char* group = "History commands";

  // Commands
  theCommands.Add("setfillhistory",
                  "Controls the history collection by the algorithms and its saving into the "
                  "session after algorithm is done.\n"
                  "\t\tUsage: setfillhistory [flag]\n"
                  "\t\tw/o arguments prints the current state of the option;\n"
                  "\t\tflag == 0 - history will not be collected and saved;\n"
                  "\t\tflag != 0 - history will be collected and saved into the session (default).",
                  __FILE__,
                  SetFillHistory,
                  group);

  theCommands.Add(
    "savehistory",
    "savehistory name\n"
    "\t\tSaves the history from the session into a drawable object with the name <name>.",
    __FILE__,
    SaveHistory,
    group);

  theCommands.Add("modified",
                  "modified modified_shapes history shape\n"
                  "\t\tReturns the shapes Modified from the given shape in the given history",
                  __FILE__,
                  Modified,
                  group);

  theCommands.Add("generated",
                  "generated generated_shapes history shape\n"
                  "\t\tReturns the shapes Generated from the given shape in the given history",
                  __FILE__,
                  Generated,
                  group);

  theCommands.Add("isdeleted",
                  "isdeleted history shape\n"
                  "\t\tChecks if the given shape has been deleted in the given history",
                  __FILE__,
                  IsDeleted,
                  group);
}

//=================================================================================================

int SetFillHistory(Draw_Interpretor& theDI, int theArgc, const char** theArgv)
{
  if (theArgc > 2)
  {
    theDI.PrintHelp(theArgv[0]);
    return 1;
  }

  if (theArgc == 1)
  {
    theDI << "Filling of the history is "
          << (BRepTest_Objects::IsHistoryNeeded() ? "enabled." : "disabled.");
  }
  else
  {
    int iHist = Draw::Atoi(theArgv[1]);
    BRepTest_Objects::SetToFillHistory(iHist != 0);
  }
  return 0;
}

//=================================================================================================

int SaveHistory(Draw_Interpretor& theDI, int theArgc, const char** theArgv)
{
  if (theArgc != 2)
  {
    theDI.PrintHelp(theArgv[0]);
    return 1;
  }

  // Get the history from the session
  occ::handle<BRepTools_History> aHistory = BRepTest_Objects::History();
  if (aHistory.IsNull())
  {
    theDI << "No history has been prepared yet.";
    return 1;
  }

  occ::handle<BRepTest_DrawableHistory> aDrawHist = new BRepTest_DrawableHistory(aHistory);

  Draw::Set(theArgv[1], aDrawHist);

  return 0;
}

//=================================================================================================

static occ::handle<BRepTools_History> GetHistory(Draw_Interpretor& theDI, const char* theName)
{
  occ::handle<BRepTest_DrawableHistory> aHistory =
    occ::down_cast<BRepTest_DrawableHistory>(Draw::Get(theName));

  if (aHistory.IsNull() || aHistory->History().IsNull())
  {
    theDI << "History with the name " << theName << " does not exist.";
    return nullptr;
  }

  return aHistory->History();
}

//=================================================================================================

static TopoDS_Shape GetShape(Draw_Interpretor& theDI, const char* theName)
{
  TopoDS_Shape aS = DBRep::Get(theName);

  if (aS.IsNull())
  {
    theDI << theName << " is a null shape.";
    return TopoDS_Shape();
  }

  if (!BRepTools_History::IsSupportedType(aS))
  {
    theDI << "History is not supported for this kind of shape.";
    return TopoDS_Shape();
  }
  return aS;
}

//=================================================================================================

static TopoDS_Shape MakeCompound(const NCollection_List<TopoDS_Shape>& theLS)
{
  TopoDS_Shape aC;
  if (theLS.Extent() == 1)
  {
    aC = theLS.First();
  }
  else
  {
    BRep_Builder().MakeCompound(TopoDS::Compound(aC));
    NCollection_List<TopoDS_Shape>::Iterator it(theLS);
    for (; it.More(); it.Next())
    {
      BRep_Builder().Add(aC, it.Value());
    }
  }
  return aC;
}

//=================================================================================================

int Modified(Draw_Interpretor& theDI, int theArgc, const char** theArgv)
{
  if (theArgc != 4)
  {
    theDI.PrintHelp(theArgv[0]);
    return 1;
  }

  occ::handle<BRepTools_History> aHistory = GetHistory(theDI, theArgv[2]);
  if (aHistory.IsNull())
  {
    return 1;
  }

  TopoDS_Shape aS = GetShape(theDI, theArgv[3]);
  if (aS.IsNull())
  {
    return 1;
  }

  const NCollection_List<TopoDS_Shape>& aModified = aHistory->Modified(aS);

  if (aModified.IsEmpty())
  {
    theDI << "The shape has not been modified.";
    return 0;
  }

  DBRep::Set(theArgv[1], MakeCompound(aModified));

  return 0;
}

//=================================================================================================

int Generated(Draw_Interpretor& theDI, int theArgc, const char** theArgv)
{
  if (theArgc != 4)
  {
    theDI.PrintHelp(theArgv[0]);
    return 1;
  }

  occ::handle<BRepTools_History> aHistory = GetHistory(theDI, theArgv[2]);
  if (aHistory.IsNull())
  {
    return 1;
  }

  TopoDS_Shape aS = GetShape(theDI, theArgv[3]);
  if (aS.IsNull())
  {
    return 1;
  }

  const NCollection_List<TopoDS_Shape>& aGenerated = aHistory->Generated(aS);

  if (aGenerated.IsEmpty())
  {
    theDI << "No shapes were generated from the shape.";
    return 0;
  }

  DBRep::Set(theArgv[1], MakeCompound(aGenerated));

  return 0;
}

//=================================================================================================

int IsDeleted(Draw_Interpretor& theDI, int theArgc, const char** theArgv)
{
  if (theArgc != 3)
  {
    theDI.PrintHelp(theArgv[0]);
    return 1;
  }

  occ::handle<BRepTools_History> aHistory = GetHistory(theDI, theArgv[1]);
  if (aHistory.IsNull())
  {
    return 1;
  }

  TopoDS_Shape aS = GetShape(theDI, theArgv[2]);
  if (aS.IsNull())
  {
    return 1;
  }

  theDI << (aHistory->IsRemoved(aS) ? "Deleted." : "Not deleted.");

  return 0;
}