coriolis/hurricane/src/viewer/PyCellViewer.cpp

// -*- C++ -*-
//
// This file is part of the Coriolis Software.
// Copyright (c) UPMC 2010-2018, All Rights Reserved
//
// +-----------------------------------------------------------------+ 
// |                   C O R I O L I S                               |
// |    I s o b a r  -  Hurricane / Python Interface                 |
// |                                                                 |
// |  Author      :                    Jean-Paul CHAPUT              |
// |  E-mail      :       Jean-Paul.Chaput@asim.lip6.fr              |
// | =============================================================== |
// |  C++ Module  :       "./PyCellViewer.cpp"                       |
// +-----------------------------------------------------------------+


#include "hurricane/isobar/PyBox.h"
#include "hurricane/isobar/PyCell.h"
#include "hurricane/isobar/PyOccurrence.h"
#include "hurricane/viewer/PyCellViewer.h"
#include "hurricane/viewer/CellWidget.h"


namespace  Isobar {

using namespace Hurricane;

extern "C" {


#define  METHOD_HEAD(function)  GENERIC_METHOD_HEAD(CellViewer,cw,function)


// +=================================================================+
// |             "PyCellViewer" Python Module Code Part              |
// +=================================================================+

#if defined(__PYTHON_MODULE__)


  // Standart Destroy (Attribute).
  DirectDestroyAttribute(PyCellViewer_destroy, PyCellViewer)


  static PyObject* PyCellViewer_hasMenu ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_hasMenu()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.hasMenu()")

    char* path = NULL;
    if (not PyArg_ParseTuple(args,"s:CellViewer.hasMenu()", &path)) {
      PyErr_SetString ( ConstructorError, "CellViewer.hasMenu(): Takes exactly one argument." );
      return NULL;
    }

    if (cw->hasMenu( path )) Py_RETURN_TRUE;
    HCATCH

    Py_RETURN_FALSE;
  }


  static PyObject* PyCellViewer_hasMenuAction ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_hasMenuAction()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.hasMenuAction()")

    char* path = NULL;
    if (not PyArg_ParseTuple(args,"s:CellViewer.hasMenuAction()", &path)) {
      PyErr_SetString ( ConstructorError, "CellViewer.hasMenuAction(): Takes exactly one argument." );
      return NULL;
    }

    if (cw->hasMenuAction( path )) Py_RETURN_TRUE;
    HCATCH

    Py_RETURN_FALSE;
  }


  static PyObject* PyCellViewer_addMenu ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_addMenu()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.addMenu()")

    char* path  = NULL;
    char* text  = NULL;
    long  flags = 0;
    if (not PyArg_ParseTuple(args,"ssl:CellViewer.addMenu()", &path, &text, &flags)) {
      PyErr_SetString ( ConstructorError, "CellViewer.addMenu(): Takes exactly three arguments." );
      return NULL;
    }

    if (cw->addMenu( path, text, flags )) Py_RETURN_TRUE;
    HCATCH

    Py_RETURN_FALSE;
  }


  static PyObject* PyCellViewer_addToMenu ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_addToMenu()" << endl;

    HTRY
      METHOD_HEAD("CellViewer.addToMenu()")
  
      QString  before       ("");
      char*    path       = NULL;
      char*    text       = NULL;
      char*    textTip    = NULL;
      char*    scriptPath = NULL;
      char*    beforeArg  = NULL;
      if (not PyArg_ParseTuple( args, "s|ssss:CellViewer.addToMenu()"
                                    , &path, &text, &textTip, &scriptPath, &beforeArg)) {
        PyErr_SetString ( ConstructorError, "CellViewer.addToMenu(): Takes either one or five arguments." );
        return NULL;
      }
  
      if (beforeArg != NULL) before = beforeArg;
      
      if (text != NULL) {
        if (cw->addToMenu( path, text, textTip, scriptPath, before )) Py_RETURN_TRUE;
      } else {
        if (cw->addToMenu( path, before )) Py_RETURN_TRUE;
      }
    HCATCH

    Py_RETURN_FALSE;
  }


  static PyObject* PyCellViewer_getCell ( PyCellViewer* self )
  {
    cdebug_log(20,0) << "PyCellViewer_getCell ()" << endl;

    Cell* cell = NULL;
    
    HTRY
    METHOD_HEAD("CellViewer.getCell()")

    cell = cw->getCell ();
    HCATCH

    if ( cell == NULL ) Py_RETURN_NONE;

    return PyCell_Link(cell);
  }


  static PyObject* PyCellViewer_setCell ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_setCell ()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.setCell()")

    PyCell* cell;
    if ( not ParseOneArg("CellViewer.setCell()",args,CELL_ARG,(PyObject**)&cell) ) {
      return NULL;
    }

    cw->setCell ( PYCELL_O(cell) );
    HCATCH

    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_setDbuMode ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_setDbuMode ()" << endl;
    HTRY
      METHOD_HEAD( "CellViewer.setDbuMode()" )
      int dbuMode = DbU::Symbolic;
      if (not PyArg_ParseTuple(args,"i:CellViewer.setDbuMode()", &dbuMode)) {
        PyErr_SetString ( ConstructorError, "CellViewer.setDbuMode(): Takes exactly one argument." );
        return NULL;
      }
      cw->setDbuMode ( dbuMode );
    HCATCH
    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_setApplicationName ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_setApplicationName ()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.setApplicationName()")

    char* name = NULL;
    if (not PyArg_ParseTuple(args,"s:CellViewer.setApplicationName()", &name)) {
      PyErr_SetString ( ConstructorError, "CellViewer.setApplicationName(): Takes exactly one argument." );
      return NULL;
    }

    cw->setApplicationName ( name );
    HCATCH

    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_setLayerVisible ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_setLayerVisible ()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.setLayerVisible()")

    char*     layerName = NULL;
    PyObject* visible   = NULL;
    if (not PyArg_ParseTuple(args,"sO:CellViewer.setLayerVisible()", &layerName, &visible)) {
      PyErr_SetString ( ConstructorError, "CellViewer.setLayerVisible(): Takes exactly two argument." );
      return NULL;
    }

    cw->setLayerVisible ( layerName, (PyObject_IsTrue(visible) != 0) );
    HCATCH

    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_setAnonNetSelectable ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_setAnonNetSelectable ()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.setAnonNetSelectable()")

    PyObject* pyState = NULL;
    if (not PyArg_ParseTuple(args,"O:CellViewer.setAnonNetSelectable()", &pyState)) {
      PyErr_SetString ( ConstructorError, "CellViewer.setAnonNetSelectable(): Takes exactly one argument." );
      return NULL;
    }

    bool state = (PyObject_IsTrue(pyState) != 0);
    cw->setAnonNetSelectable( state );
    HCATCH

    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_select ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_select()" << endl;
    HTRY
      METHOD_HEAD("CellViewer.select()")
      PyObject* pyOccurrence = NULL;
      if (not PyArg_ParseTuple(args,"O:CellViewer.select()", &pyOccurrence)) {
        PyErr_SetString ( ConstructorError, "CellViewer.select(): Takes exactly one argument." );
        return NULL;
      }
      if (not IsPyOccurrence(pyOccurrence)) {
        PyErr_SetString ( ConstructorError, "CellViewer.select(): Argument is not an Occurrence." );
        return NULL;
      }
      cw->select( *(PYOCCURRENCE_O(pyOccurrence)) );
    HCATCH
    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_unselect ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_unselect()" << endl;
    HTRY
      METHOD_HEAD("CellViewer.unselect()")
      PyObject* pyOccurrence = NULL;
      if (not PyArg_ParseTuple(args,"O:CellViewer.unselect()", &pyOccurrence)) {
        PyErr_SetString ( ConstructorError, "CellViewer.unselect(): Takes exactly one argument." );
        return NULL;
      }
      if (not IsPyOccurrence(pyOccurrence)) {
        PyErr_SetString ( ConstructorError, "CellViewer.unselect(): Argument is not an Occurrence." );
        return NULL;
      }
      cw->unselect( *(PYOCCURRENCE_O(pyOccurrence)) );
    HCATCH
    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_unselectAll ( PyCellViewer* self )
  {
    cdebug_log(20,0) << "PyCellViewer_unselectAll()" << endl;
    HTRY
      METHOD_HEAD("CellViewer.unselectAll()")
      cw->unselectAll();
    HCATCH
    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_reframe ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_reframe ()" << endl;
    HTRY
      METHOD_HEAD("CellViewer.reframe()")
      PyObject* pyBox         = NULL;
      PyObject* historyEnable = NULL;
      if (not PyArg_ParseTuple(args,"OO:CellViewer.reframe()", &pyBox, &historyEnable)) {
        PyErr_SetString ( ConstructorError, "CellViewer.reframe(): Takes exactly two argument." );
        return NULL;
      }
      if (not IsPyBox(pyBox)) {
        PyErr_SetString ( ConstructorError, "CellViewer.reframe(): First argument is not a Box." );
        return NULL;
      }
      cw->reframe ( *(PYBOX_O(pyBox)), (PyObject_IsTrue(historyEnable) != 0) );
      HCATCH
    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_fit ( PyCellViewer* self )
  {
    cdebug_log(20,0) << "PyCellViewer_fit()" << endl;
    HTRY
      METHOD_HEAD("CellViewer.fit()")
      cw->getCellWidget()->fitToContents();
    HCATCH
    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_refresh ( PyCellViewer* self )
  {
    cdebug_log(20,0) << "PyCellViewer_refresh()" << endl;

    HTRY
    METHOD_HEAD("CellViewer.refresh()")
    cw->getCellWidget()->refresh();
    HCATCH

    Py_RETURN_NONE;
  }


  static PyObject* PyCellViewer_removeHistory ( PyCellViewer* self, PyObject* args )
  {
    cdebug_log(20,0) << "PyCellViewer_removeHistory ()" << endl;

    HTRY
      METHOD_HEAD("CellViewer.removeHistory()")
  
      PyCell* cell;
      if ( not ParseOneArg("CellViewer.removeHistory()",args,CELL_ARG,(PyObject**)&cell) ) {
        return NULL;
      }
      cw->removeHistory ( PYCELL_O(cell) );
    HCATCH
    Py_RETURN_NONE;
  }


  DirectSetBoolAttribute(PyCellViewer_setShowSelection      ,setShowSelection      ,PyCellViewer,CellViewer)
  DirectSetBoolAttribute(PyCellViewer_setCumulativeSelection,setCumulativeSelection,PyCellViewer,CellViewer)


  // ---------------------------------------------------------------
  // PyCellViewer Attribute Method table.

  PyMethodDef PyCellViewer_Methods[] =
    { { "hasMenu"               , (PyCFunction)PyCellViewer_hasMenu               , METH_VARARGS
                                , "Return true if the menu at \"path\" exists." }
    , { "hasMenuAction"         , (PyCFunction)PyCellViewer_hasMenuAction         , METH_VARARGS
                                , "Return true if the menu action at \"path\" exists." }
    , { "addMenu"               , (PyCFunction)PyCellViewer_addMenu               , METH_VARARGS
                                , "Create a new menu at \"path\" and returns true if success." }
    , { "addToMenu"             , (PyCFunction)PyCellViewer_addToMenu             , METH_VARARGS
                                , "Creates a new action at \"path\" and returns true if success." }
    , { "getCell"               , (PyCFunction)PyCellViewer_getCell               , METH_NOARGS
                                , "Return the currently edited Cell." }
    , { "setCell"               , (PyCFunction)PyCellViewer_setCell               , METH_VARARGS
                                , "Load a Cell into the viewer." }
    , { "setApplicationName"    , (PyCFunction)PyCellViewer_setApplicationName    , METH_VARARGS
                                , "Sets the application (binary) name." }
    , { "setDbuMode"            , (PyCFunction)PyCellViewer_setDbuMode            , METH_VARARGS
                                , "Sets how the length will be displayed (lambda,physical,grid)." }
    , { "setAnonNetSelectable"  , (PyCFunction)PyCellViewer_setAnonNetSelectable  , METH_VARARGS
                                , "Allow/disallow anonymous nets to be selectables." }
    , { "setLayerVisible"       , (PyCFunction)PyCellViewer_setLayerVisible       , METH_VARARGS
                                , "Sets the visibility state of the layer <name>." }
    , { "setShowSelection"      , (PyCFunction)PyCellViewer_setShowSelection      , METH_VARARGS
                                , "Display/hide the selection." }
    , { "setCumulativeSelection", (PyCFunction)PyCellViewer_setCumulativeSelection, METH_VARARGS
                                , "Make the selection cumulative." }
    , { "select"                , (PyCFunction)PyCellViewer_select                , METH_VARARGS
                                , "Add an occurrence to the selected set." }      
    , { "unselect"              , (PyCFunction)PyCellViewer_unselect              , METH_VARARGS
                                , "Add an occurrence to the selected set." }      
    , { "unselectAll"           , (PyCFunction)PyCellViewer_unselectAll           , METH_NOARGS
                                , "Clear the selected set." }                     
    , { "reframe"               , (PyCFunction)PyCellViewer_reframe               , METH_VARARGS
                                , "Zoom toward the given area." }
    , { "fit"                   , (PyCFunction)PyCellViewer_fit                   , METH_NOARGS
                                , "Triggers a full redraw of the visible area." }
    , { "refresh"               , (PyCFunction)PyCellViewer_refresh               , METH_NOARGS
                                , "Fit the contents to the viewer's visible area  ." }
    , { "removeHistory"         , (PyCFunction)PyCellViewer_removeHistory         , METH_VARARGS
                                , "Remove a Cell from the viewer's history." }
    , { "destroy"               , (PyCFunction)PyCellViewer_destroy               , METH_NOARGS
                                , "Destroy the associated hurricane object. The python object remains." }
    , {NULL, NULL, 0, NULL}     /* sentinel */
    };


  PythonOnlyDeleteMethod(CellViewer)
  PyTypeObjectLinkPyType(CellViewer)


#else  // End of Python Module Code Part.


// +=================================================================+
// |            "PyCellViewer" Shared Library Code Part              |
// +=================================================================+


  LinkCreateMethod(CellViewer)
  PyTypeRootObjectDefinitions(CellViewer)


  static void  CellViewerLoadConstants ( PyObject* dictionnary ) {
    PyObject* constant;

    LoadObjectConstant( dictionnary, CellViewer::NoFlags, "NoFlags" )
    LoadObjectConstant( dictionnary, CellViewer::TopMenu, "TopMenu" )
  }


  extern  void  PyCellViewer_postModuleInit ()
  {
    CellViewerLoadConstants(PyTypeCellViewer.tp_dict);
  }

# endif  // End of Shared Library Code Part.


}  // End of extern "C".


}  // End of Isobar namespace.