/*

  KLayout Layout Viewer
  Copyright (C) 2006-2017 Matthias Koefferlein

  This program 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.

  This program 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 this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

*/


#ifndef HDR_layTechnologyController
#define HDR_layTechnologyController

#include "layCommon.h"
#include "layPlugin.h"
#include "layTechnology.h"
#include "layAbstractMenu.h"

#include <vector>

namespace lay
{

class TechSetupDialog;
class MainWindow;
class MacroCollection;

/**
 *  @brief A "controller" for the technologies
 *  The main task of the controller is to establish and manage the
 *  list of technologies and to manage the active technology.
 */
class LAY_PUBLIC TechnologyController
  : public PluginDeclaration,
    public tl::Object
{
Q_OBJECT

public:
  /**
   *  @brief Constructor
   */
  TechnologyController ();

  void initialize (lay::PluginRoot *root);
  void initialized (lay::PluginRoot *root);
  void uninitialize (lay::PluginRoot *root);

  void get_options (std::vector < std::pair<std::string, std::string> > &options) const;
  void get_menu_entries (std::vector<lay::MenuEntry> &menu_entries) const;

  void show_editor ();

  /**
   *  @brief Gets the active technology object or 0 if none is active
   *  The active technology is the one the current cellview uses
   */
  lay::Technology *active_technology () const;

  /**
   *  @brief Enables or disables macros
   *  If macros are enabled, the macro tree contains the macros defined within the technologies.
   *  This flag needs to be set initially and before the technology tree is updated.
   */
  void enable_macros (bool enable);

  /**
   *  @brief Adds a path as a search path for technologies
   *  "refresh" needs to be called after search paths have been added.
   */
  void add_path (const std::string &path);

  /**
   *  @brief Adds a temporary technology
   *  Temporary technologies are additional technologies which are added to the list of technologies
   *  but are not persisted or editable.
   *  "refresh" needs to be called after temp technologies have been added.
   */
  void add_temp_tech (const lay::Technology &t);

  /**
   *  @brief Updates the given technology collection with the technologies from the search path and teh temp technologies
   */
  void refresh (lay::Technologies &technologies);

  /**
   *  @brief Refreshes the global list of technologies
   */
  void refresh ();

  /**
   *  @brief Gets the default root folder
   *  The default root is the first one of the paths added with add_path.
   */
  const std::string &default_root ();

  /**
   *  @brief Gets the singleton instance of the controller
   */
  static TechnologyController *instance ();

signals:
  /**
   *  @brief This signal is emitted if the active technology has changed
   */
  void active_technology_changed ();

  /**
   *  @brief This signal is emitted if the technology list has been edited
   *  This signal is emitted if either the list or one technology has been
   *  edited. It indicates the need for reflecting changes in the technology
   *  setup.
   */
  void technologies_edited ();

private:
  tl::stable_vector <lay::Action> m_tech_actions;
  std::string m_current_technology;
  bool m_current_technology_updated;
  bool m_technologies_configured;
  lay::TechSetupDialog *mp_editor;
  lay::MainWindow *mp_mw;
  bool m_no_macros;
  std::vector<std::string> m_paths;
  std::vector<lay::Technology> m_temp_tech;
  std::set<std::pair<std::string, std::string> > m_tech_macro_paths;
  lay::Technology *mp_active_technology;

  void update_active_technology ();
  void connect_events ();
  void technologies_changed ();
  void technology_changed (lay::Technology *);
  bool configure (const std::string &name, const std::string &value);
  void config_finalize ();
  bool menu_activated (const std::string &symbol) const;
  void update_current_technology ();
  void update_menu ();
  std::vector<lay::MacroCollection *> sync_tech_macro_locations ();
};

}

#endif