// aptitude_resolver.h                  -*-c++-*-
//
// 
//   Copyright (C) 2005 Daniel Burrows

//   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; see the file COPYING.  If not, write to
//   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
//   Boston, MA 02111-1307, USA.
//
// Glue code to make the resolver talk to the core aptitude classes.
//
// shootshootshoot...maybe I should just teach the core about
// conflicts...anyway, if not, then I need to be much more careful how
// I iterate over conflicts if an OR is involved (it should be
// basically ignored)
//
// General comment on how the iterators are handled: basically the
// technique is (generally) to have a normalize() routine that
// advances the current iterator(s) to the next "interesting"
// iterator.  For instance, broken_dep_iterator::normalize() moves to
// the next broken dependency (sort of).  If the current iterator is
// already interesting, nothing happens.  This is used on
// initialization and in operator++ (after advancing the iterator a
// single step manually).

#ifndef APTITUDE_RESOLVER_H
#define APTITUDE_RESOLVER_H

#include "aptitude_resolver_universe.h"

#include <generic/problemresolver/problemresolver.h>

class aptitude_resolver:public generic_problem_resolver<aptitude_universe>
{
public:
  aptitude_resolver(int step_score, int broken_score,
		    int unfixed_soft_score,
		    int infinity, int max_successors,
		    int resolution_score,
		    aptitudeDepCache *cache);

  /** Assign scores to all packages and all package versions according
   *  to its arguments.  All scores are assigned with add_score, so
   *  this can be easily combined with other policies.
   *
   * \param preserve_score the score to assign to the version that the
   * user selected.
   *
   * \param auto_score the score to assign to automatically assigned
   * actions.  By making this smaller than preserve_score you can bias
   * the system towards overriding automatic decisions rather than
   * user actions.
   *
   * \param remove_score the score to assign to removing a package
   * against the user's wishes.
   *
   * \param keep_score the score to assign to cancelling actions on a
   * package against the user's wishes.
   *
   * \param install_score the score to assign to removing a package
   * against the user's wishes.
   *
   * \param upgrade_score the score to assign to upgrading a package
   * against the user's wishes.
   *
   * \param non_default_score the score to assign to installing a
   * non-default version of a package (such as a downgrade or an
   * experimental version).
   *
   * \param essential_remove an additional modification applied to the
   * removal of an essential package (typically used to deep-six such
   * solutions by, eg, setting it to -100000)
   *
   * \param break_hold_score an additional modification applied to
   * solutions that break a hold or violate a forbidding.
   */
  void add_action_scores(int preserve_score, int auto_score,
			 int remove_score, int keep_score,
			 int install_score, int upgrade_score,
			 int non_default_score, int essential_remove,
			 int break_hold_score);

  /** Score packages/versions according to their priorities.  Normally
   *  you want important>=required>=standard>=optional>=extra.
   *
   *  \param important score modification for Important versions
   *  \param required score modification for Required versions
   *  \param standard score modification for Standard versions
   *  \param optional score modification for Optional versions
   *  \param extra score modification for Extra versions
   */
  void add_priority_scores(int important, int required, int standard,
			   int optional, int extra);
};

#endif