godleyIcon.cc

Go to the documentation of this file.

/*
  @copyright Steve Keen 2012
  @author Russell Standish
  This file is part of Minsky.

  Minsky 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 3 of the License, or
  (at your option) any later version.

  Minsky 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 Minsky.  If not, see <http://www.gnu.org/licenses/>.
*/
#include "minsky.h"
#include "variable.h"
#include "godleyIcon.h"
#include "godleyTableWindow.h"
#include "cairoItems.h"
#include "selection.h"
#include <flowCoef.h>
#include <evalGodley.h>
#include <arrays.h>
#include <cairo_base.h>
#include <ctype.h>
#include "godleyIcon.rcd"
#include "itemT.rcd"
#include "godleyTableWindow.xcd"
#include "minsky_epilogue.h"
#include <boost/locale.hpp>
using namespace boost::locale::conv;
using namespace ecolab::cairo;
using namespace ecolab;
using namespace std;

// width of draggable border 
const float border=10;

namespace minsky
{
  namespace
  {
    struct OrderByName
    {
      bool operator()(const VariablePtr& x, const VariablePtr& y) const
      {assert(x&&y); return x->valueId() < y->valueId();} 
    };

    struct DrawVars
    {
      cairo_t* cairo;
      float x, y; // position of this icon
      DrawVars(cairo_t* cairo, float x, float y): 
        cairo(cairo), x(x), y(y) {}
      
      void operator()(const GodleyIcon::Variables& vars) const
      {
        for (GodleyIcon::Variables::const_iterator v=vars.begin(); 
             v!=vars.end(); ++v)
          {
            const ecolab::cairo::CairoSave cs(cairo);
            const VariableBase& vv=**v;
            // coordinates of variable within the cairo context
            cairo_translate(cairo, vv.x()-x, vv.y()-y);
            vv.draw(cairo);
          }
      }
    };

    // determine the width and maximum height on screen of variables in vars
    void accumulateWidthHeight(const GodleyIcon::Variables& vars,
                               float& height, float& width)
    {
      float h=0;
      for (const auto& v: vars)
        { 
          const RenderVariable rv(*v);
          h+=2*rv.height();
          if (h>height) height=h;
          const float w=2*rv.width();
          if (w>width) width=w;
        }
    }
  }

  bool GodleyIcon::inItem(float xx, float yy) const
  {
    return abs(xx-x())<0.5*width()-border && abs(yy-y())<0.5*height()-border;
  }

  void GodleyIcon::updateVars(GodleyIcon::Variables& vars, 
                              const vector<string>& varNames, 
                              VariableType::Type varType)
  {
    // update the map of variables from the Godley table
    set<VariablePtr, OrderByName> oldVars(vars.begin(), vars.end());
    set<string> alreadyAdded;

    vars.clear();
    shared_ptr<GodleyIcon> self;
    if (auto g=group.lock())
      self=dynamic_pointer_cast<GodleyIcon>(g->findItem(*this));
      
    for (vector<string>::const_iterator nm=varNames.begin(); nm!=varNames.end(); ++nm)
      {
        const VariablePtr newVar(varType, *nm);
        auto myGroup=group.lock();
        if (myGroup) myGroup->addItem(newVar); // get scope right
        auto v=oldVars.find(newVar);
          
        if (v==oldVars.end())
          {     
            // allow for the possibility that multiple names map to the same valueId
            if (!alreadyAdded.contains(newVar->valueId()))
              {
                // add new variable
                vars.push_back(newVar);
                alreadyAdded.insert(newVar->valueId());
                if (varType==VariableType::stock) // newly added variables should take the default dimension
                  newVar->setUnits(currency);
              }
            else
              if (myGroup)
                myGroup->removeItem(*newVar);
          }
        else
          {
            // move existing variable
            assert(*v);
            vars.push_back(*v);
            alreadyAdded.insert(newVar->valueId());
            oldVars.erase(v);
            if (myGroup) myGroup->removeItem(*newVar);
          }
        if (myGroup) myGroup->addItem(vars.back(),true);
        vars.back()->controller=self;
        // ensure variable type is consistent
        minsky::minsky().convertVarType(vars.back()->valueId(), varType);
      }
    // remove any previously existing variables
    if (auto g=group.lock())
      for (const auto& v: oldVars)
        g->deleteItem(*v);   
  }

  void GodleyIcon::toggleVariableDisplay()
  {
    m_variableDisplay=!m_variableDisplay;
    update();
  }
  
  void GodleyIcon::toggleEditorMode()
  {
    m_editorMode=!m_editorMode;
    updateBoundingBox();
  }

  bool GodleyIcon::buttonDisplay() const {return m_editorMode && editor.drawButtons;}
  void GodleyIcon::toggleButtons()
  {
    if (editor.drawButtons)
      editor.disableButtons();
    else
      editor.enableButtons();
    updateBoundingBox();
  }
  
  void GodleyIcon::scaleIcon(float w, float h)
  {
    update();
    scaleFactor(min(w/(leftMargin()+iWidth()*zoomFactor()),h/(bottomMargin()+iHeight()*zoomFactor())));
  }  

  void GodleyIcon::resize(const LassoBox& b)
  {
    const float invZ=1.0/(this->zoomFactor());
    auto bw=abs(b.x0-b.x1), bh=abs(b.y0-b.y1);
    if (bw<=leftMargin() || bh<=bottomMargin()) return;
    moveTo(0.5*(b.x0+b.x1), 0.5*(b.y0+b.y1));
    iWidth((bw-leftMargin())*invZ);
    iHeight((bh-bottomMargin())*invZ);  
    scaleIcon(bw,bh);
    updateBoundingBox();
  }

  void GodleyIcon::removeControlledItems(GroupItems& g)
  {
    for (auto& i: m_flowVars)
      {
        assert(i);
        i->deleteAttachedWires();
        auto item=g.removeItem(*i);
        assert(item.use_count()!=1);
      }
    m_flowVars.clear();
    for (auto& i: m_stockVars)
      {
        assert(i);
        i->deleteAttachedWires();
        auto item=g.removeItem(*i);
        assert(item.use_count()!=1);
      }
    m_stockVars.clear();
  }

  void GodleyIcon::setCell(int row, int col, const string& newVal) 
  {
    if (!table.cellInTable(row,col)) return;
    // if this operation is clearing an initial condition cell, set it to 0
    string& c=table.cell(row,col);
    if (newVal.empty() && !c.empty() && table.initialConditionRow(row))
      c="0";
    else
      c=newVal; 
    if (row==0)
      minsky().importDuplicateColumn(table, col);
    else
      minsky().balanceDuplicateColumns(*this, col);
    table.markEdited();
  }

  void GodleyIcon::deleteRow(unsigned row)
  {
    if (row>0 && row<=table.rows())
      {
        table.deleteRow(row-1);
        // if shared column data is deleted, remove it from the other tables too
        for (size_t col=1; col<table.cols(); ++col)
          minsky().balanceDuplicateColumns(*this, col);
        table.markEdited();
      }
  }

  //void GodleyIcon::moveCell(int srcRow, int srcCol, int destRow, int destCol)
  void GodleyIcon::moveCell(const MoveCellArgs& args)
  {
    if (!table.cellInTable(args.srcRow, args.srcCol) || !table.cellInTable(args.destRow, args.destCol)) return;
    if (args.srcCol!=args.destCol) // if moving between columns, we can delete and
      // add, which ensures any linked columns are
      // correctly updated
      {
        // create a copy here, as setCell may resize the array, changing 
        // what the reference referred to.
        const string oldVal=table.cell(args.srcRow, args.srcCol);
        setCell(args.destRow, args.destCol, oldVal);
        setCell(args.srcRow, args.srcCol, "");
      }
    else // within a column, just move the data without affecting any linked column
      {
        table.cell(args.destRow, args.destCol)=table.cell(args.srcRow, args.srcCol);
        table.cell(args.srcRow, args.srcCol)="";
      }
  }

  map<string,double> GodleyIcon::flowSignature(unsigned col) const
  {
    map<string,double> r;
    for (size_t row=1; row<table.rows() && col<table.cols(); ++row)
      if (!table.initialConditionRow(row))
        {
          const FlowCoef fc(table.cell(row,col));
          if (!fc.name.empty())
            r[fc.name]+=fc.coef;
        }
    return r;
  }

  vector<Summary> GodleyIcon::summarise() const
  {
    vector<Summary> r;
    for (auto& i: stockVars())
      if (auto vv=i->vValue())
        {
          r.push_back(vv->summary());
          r.back().godley=table.title.empty()? id(): table.title;
        }
    for (auto& i: flowVars())
      if (auto vv=i->vValue())
        {
          r.push_back(vv->summary());
          r.back().godley=table.title.empty()? id(): table.title;
        }
    return r;
  }
  
  void GodleyIcon::update()
  {
    updateVars(m_stockVars, table.getColumnVariables(), VariableType::stock);
    updateVars(m_flowVars, table.getVariables(), VariableType::flow);

    // retrieve initial conditions, if any
    for (size_t r=1; r<table.rows(); ++r)
      if (table.initialConditionRow(r))
        for (size_t c=1; c<table.cols(); ++c)
          {
            const string name=trimWS(table.cell(0,c));           
            auto vi=minsky().variableValues.find(minsky::valueId(group.lock(),name));
            if (vi==minsky().variableValues.end()) continue;
            VariableValue& v=*vi->second;           
            v.godleyOverridden=false;
            const string::size_type start=table.cell(r,c).find_first_not_of(' ');
            if (start!=string::npos)
              {
                const FlowCoef fc(table.cell(r,c).substr(start));                                      
                v.init(fc.str());              
                // set initial value of stock var to init value of flow that is defined by a parameter or a constant. for ticket 1137
                if (auto initVar=minsky().definingVar(minsky::valueId(group.lock(),fc.str())))
                  if (initVar->inputWired() && initVar->type()==VariableType::flow)
                    if (auto* lhsVar=initVar->ports(1).lock()->wires()[0]->from()->item().variableCast()) {
                      FlowCoef fc1(lhsVar->vValue()->init());
                      fc1.coef*=fc.coef;
                      v.init(fc1.str());        
                    }       
                v.godleyOverridden=true;
              }
            else
              { 
                // populate cell with current variable's initial value
                const FlowCoef fc(v.init());   
                table.cell(r,c)=fc.str();
                v.godleyOverridden=true;
              }

          }

    if (m_variableDisplay)
      {
        // determine height of variables part of icon
        float stockH=0, flowH=0;
        stockMargin=0;
        flowMargin=0;
        accumulateWidthHeight(m_stockVars, stockH, stockMargin);
        accumulateWidthHeight(m_flowVars, flowH, flowMargin);
        // allow for notches on variables
        stockMargin+=4;
        flowMargin+=4;
        const float iw=this->iWidth(), ih=this->iHeight();
        this->iWidth(max(iw, 1.8f*stockH));
        this->iHeight(max(ih, 1.8f*flowH));
      }
    else
      { // if any variables have attached wires, create a copy to carry the wire
        for (auto& v: m_stockVars)
          if (auto p=v->ports(0).lock())
            if (!p->wires().empty())
              {
                if (auto g=group.lock())
                  {
                    auto newVar=g->addItem(v->clone());
                    if (auto w=p->wires().front())
                      if (auto from=newVar->ports(0).lock())
                        {
                          w->moveToPorts(from, w->to());
                          continue;
                        }
                  }
                // in falling through to here, we've failed to create and wire a variable copy
                m_variableDisplay=true;
                throw_error("Cowardly refusing to hide a wired variable");
              }
        
        for (auto& v: m_flowVars)
          if (auto p=v->ports(1).lock())
            if (!p->wires().empty())
              {
                if (auto g=group.lock())
                  {
                    auto newVar=g->addItem(v->clone());
                    if (auto w=p->wires().front())
                      if (auto to=newVar->ports(1).lock())
                        {
                          w->moveToPorts(w->from(), to);
                          continue;
                        }
                  }
                // in falling through to here, we've failed to create and wire a variable copy
                m_variableDisplay=true;
                throw_error("Cowardly refusing to hide a wired variable");
              }
      }
    
    positionVariables();
    updateBB();
  }

  void GodleyIcon::positionVariables() const
  {
    // position of margin in absolute canvas coordinate
    const float z=this->zoomFactor()*scaleFactor();
    float x= this->x() - 0.5*iWidth()*z+0.5*leftMargin();
    float y= this->y() - 0.5*bottomMargin()-0.15*iHeight()*z;
    for (const auto& v: m_flowVars)
      {
        // right justification if displayed, left otherwisw
        v->rotation(0);
        v->moveTo(x+v->x() - (m_variableDisplay? v->right(): v->left()), y);
        y+=v->height();
      }
    x= this->x() + 0.55*leftMargin()-0.45*iWidth()*z;
    y= this->y() + 0.5*iHeight()*z-0.5*bottomMargin();

    for (const auto& v: m_stockVars)
      {
        // top justification at bottom of icon if displayed, bottom justified otherwise
        v->rotation(90);
        v->moveTo(x, y + v->y() - (m_variableDisplay? v->top(): v->bottom()));
        x+=v->width();
      }
  }

  ItemPtr GodleyIcon::select(float x, float y) const
  {
        if (m_variableDisplay)           // Disable selection of stock and flow vars when they are hidden. for tickets 1217 and 1220.
        {   
       for (const auto& v: m_flowVars)
         if (v->contains(x,y)) 
           return v;
       for (const auto& v: m_stockVars)
         if (v->contains(x,y)) 
           return v; 
     }
    return ItemPtr();
  }

  bool GodleyIcon::wiresAttached() const
  {
    bool r=false;
    for (auto& v: m_flowVars)
      if (auto p=v->ports(1).lock())
        r|=p->wires().size();
    for (auto& v: m_stockVars)
      if (auto p=v->ports(0).lock())
        r|=p->wires().size();
    return r;
  }

  
  void GodleyIcon::draw(cairo_t* cairo) const
  {
    positionVariables();
    const float z=zoomFactor()*scaleFactor();
    float w=iWidth()*z+leftMargin(), h=iHeight()*z+bottomMargin(), left=-0.5*w, top=-0.5*h;
    double titley;
    
    if (m_editorMode)
      {
        const CairoSave cs(cairo);
        cairo_rectangle(cairo, left, top, w, h);
        cairo_rectangle(cairo, left-border*z, top-border*z, w+2*border*z, h+2*border*z);
        cairo_stroke_preserve(cairo);
        if (onBorder)
          { // shadow the border when mouse is over it
            const cairo::CairoSave cs(cairo);
            cairo_set_source_rgba(cairo,0.5,0.5,0.5,0.5);
            cairo_set_fill_rule(cairo,CAIRO_FILL_RULE_EVEN_ODD);
            cairo_fill(cairo);
          }
        cairo_new_path(cairo);
        cairo_rectangle(cairo, left, top, w, h);
        cairo_clip(cairo);
        cairo_translate(cairo,left+border*z+leftMargin(),top+border*z+titleOffs()/* space for title*/);
        // render to a recording surface to determine size of editor table
        // TODO - maybe move this stuff into update()
        const Surface surf(cairo_recording_surface_create(CAIRO_CONTENT_COLOR, nullptr));
        const_cast<GodleyTableEditor&>(editor).zoomFactor=1;
        const_cast<GodleyTableEditor&>(editor).draw(surf.cairo());
        const_cast<GodleyTableEditor&>(editor).zoomFactor=min((w-leftMargin()-2*border*z)/surf.width(),(h-bottomMargin()-2*border*z-titleOffs())/surf.height());
        const_cast<GodleyTableEditor&>(editor).draw(cairo);
        titley=-0.5*h;
        w+=2*border*z;
        h+=2*border*z;
        left-=border*z;
        top-=border*z;
      }
    else
      {
        const CairoSave cs(cairo);
        cairo_translate(cairo,left+leftMargin(),top);
        svgRenderer.render(cairo, w-leftMargin(), h-bottomMargin());
        titley=top+0.1*(h-bottomMargin());
      }
    
    if (!table.title.empty())
      {
        const CairoSave cs(cairo);
        Pango pango(cairo);
        pango.setMarkup("<b>"+latexToPango(table.title)+"</b>");
        pango.setFontSize(titleOffs());
        cairo_move_to(cairo,-0.5*(pango.width()-leftMargin()), titley);
        pango.show();
      }
      
          

    if (m_variableDisplay && (!m_editorMode || wiresAttached()))
      {
        // render the variables
        const DrawVars drawVars(cairo,x(),y());
        drawVars(m_flowVars); 
        drawVars(m_stockVars); 
      }
    
    if (mouseFocus)
      {
        drawPorts(cairo);
        displayTooltip(cairo,tooltip());
        drawResizeHandles(cairo);
      }
      
    cairo_rectangle(cairo, left,top, w, h);    
    cairo_clip(cairo);
    if (selected)
      {
        drawSelected(cairo);
      }
  }

  string GodleyIcon::rowSum(int row) const
  {
    if (row==0) // A-L-E sum values across stockvars
      {
        map<string,VariablePtr> stockVars;
        for (const auto& i: m_stockVars)
          stockVars[i->valueId()]=i;
        double sum=0, absSum=0;
        for (size_t c=1; c<table.cols(); ++c)
          {
            auto i=stockVars.find(minsky::valueId(group.lock(), trimWS(table.cell(0,c))));
            if (i!=stockVars.end())
              {
                sum+=(table.signConventionReversed(c)? -1: 1)*i->second->value();
                absSum+=abs(i->second->value());
              }
          }
        if (sum<1E-4*absSum) sum=0; // eschew excess precision. For #1328
        return str(sum);
      }
    return table.rowSum(row);
  }
  
  Units GodleyIcon::stockVarUnits(const string& stockName, bool check) const
  {
    unsigned stockCol=1;
    auto valId=valueId(stockName);
    for (; stockCol<table.cols(); ++stockCol)
      if (valueId(table.cell(0,stockCol))==valId)
        break;

    if (stockCol>=table.cols()) return {};

    bool foundFlow=false;
    Units units;
    for (unsigned row=1; row<table.rows(); ++row)
      {
        if (table.initialConditionRow(row)) continue;
        const FlowCoef fc(table.cell(row,stockCol));
        if (fc.coef!=0)
          {
            auto vid=valueId(fc.name);
            // find variable assciated with this flow
            for (const auto& v: flowVars())
              if (v->valueId()==vid)
                {
                  auto flowUnits=v->units(check);
                  if (check && foundFlow && units!=flowUnits)
                    throw_error("incompatible units: "+flowUnits.str()+"≠"+units.str()+" on stock "+stockName);
                  foundFlow=true;
                  units=flowUnits;
                }
          }
      }
    if (!cminsky().timeUnit.empty())
      units[cminsky().timeUnit]++;
    return foundFlow? units: cminsky().variableValues[valId]->units;
  }

  void GodleyIcon::insertControlled(Selection& selection)
  {
    for (const auto& i: flowVars())
      selection.ensureItemInserted(i);
    for (const auto& i: stockVars())
      selection.ensureItemInserted(i);
  }
  
  ClickType::Type GodleyIcon::clickType(float x, float y) const
  {
    if (m_editorMode) return Item::clickType(x,y);
    const double dx=fabs(x-this->x()), dy=fabs(y-this->y());
    auto z=zoomFactor()*scaleFactor();
    const double w=0.5*iWidth()*z, h=0.5*iHeight()*z;
    if (onResizeHandle(x,y)) return ClickType::onResize;         
    // Make it possible to pull wires from variables attached to Godley icons. For ticket 940  
    if (auto item=select(x,y))
      return item->clickType(x,y);         
    if (dx < w && dy < h)
      return ClickType::onItem;
    return ClickType::outside;
  }

  float GodleyIcon::toEditorX(float xx) const
  {return xx-x()+0.5f*width()-2*border*zoomFactor()-leftMargin();}
  float GodleyIcon::toEditorY(float yy) const
  {return yy-y()+0.5f*height()-2*border*zoomFactor()-titleOffs();}
  
  void GodleyIcon::onMouseDown(float x, float y)
  {if (m_editorMode) editor.mouseDown(toEditorX(x),toEditorY(y));}
  
  void GodleyIcon::onMouseUp(float x, float y)
  {if (m_editorMode) editor.mouseUp(toEditorX(x),toEditorY(y));}
  
  bool GodleyIcon::onMouseMotion(float x, float y)
  {
    if (m_editorMode) editor.mouseMoveB1(toEditorX(x),toEditorY(y));
    return false;
  }
  
  bool GodleyIcon::onMouseOver(float x, float y)
  {
    if (m_editorMode) editor.mouseMove(toEditorX(x),toEditorY(y));
    return false;
  }
  
  void GodleyIcon::onMouseLeave()
  {
    if (m_editorMode)
      {
        editor.mouseMove(-1,-1);
        // May be a bit overzealous, but it solves bug 1273, which is caused by a flow which has not yet fully come into existence....
        editor.selectedCol=-1;
        editor.selectedRow=-1;
        editor.update();
      }
  }

  bool GodleyIcon::onKeyPress(int keySym, const std::string& utf8, int)
  {
    if (m_editorMode) editor.keyPress(keySym, utf8);
    return m_editorMode;
  }
  
  SVGRenderer GodleyIcon::svgRenderer;
}
CLASSDESC_ACCESS_EXPLICIT_INSTANTIATION(minsky::GodleyIcon);