RXT0112/Exheredludis
1
0
Fork 0
Code Issues Pull Requests Releases Activity
exheredrey
Exheredludis/paludis/dep_spec.hh
Wouter van Kesteren 82a9e92b64 throw() -> noexcept 
Change-Id: I461abfda8b7297c1bd04f1090f8d58fa96364616
Reviewed-on: https://galileo.mailstation.de/gerrit/1892
Reviewed-by: Saleem Abdulrasool <compnerd@compnerd.org>
Reviewed-by: Kylie McClain <somasis@exherbo.org>
2015-08-21 17:19:40 +02:00

721 lines
20 KiB
C++
Raw Permalink Blame History

/* vim: set sw=4 sts=4 et foldmethod=syntax : */
/*
* Copyright (c) 2005, 2006, 2007, 2008, 2009, 2010, 2011 Ciaran McCreesh
*
* This file is part of the Paludis package manager. Paludis is free software;
* you can redistribute it and/or modify it under the terms of the GNU General
* Public License version 2, as published by the Free Software Foundation.
*
* Paludis 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., 59 Temple
* Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef PALUDIS_GUARD_PALUDIS_DEP_SPEC_HH
#define PALUDIS_GUARD_PALUDIS_DEP_SPEC_HH 1
#include <paludis/util/attributes.hh>
#include <paludis/util/clone.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/wrapped_forward_iterator.hh>
#include <paludis/util/fs_path.hh>
#include <paludis/util/named_value.hh>
#include <paludis/changed_choices-fwd.hh>
#include <paludis/dep_label.hh>
#include <paludis/dep_spec-fwd.hh>
#include <paludis/name.hh>
#include <paludis/version_operator-fwd.hh>
#include <paludis/version_requirements-fwd.hh>
#include <paludis/version_spec-fwd.hh>
#include <paludis/slot_requirement-fwd.hh>
#include <paludis/package_id-fwd.hh>
#include <paludis/environment-fwd.hh>
#include <paludis/additional_package_dep_spec_requirement-fwd.hh>
#include <paludis/partially_made_package_dep_spec-fwd.hh>
#include <paludis/dep_spec_data-fwd.hh>
#include <paludis/dep_spec_annotations-fwd.hh>
#include <memory>
/** \file
* Declarations for dependency spec classes.
*
* \ingroup g_dep_spec
*
* \section Examples
*
* - \ref example_dep_spec.cc "example_dep_spec.cc" (for specifications)
* - \ref example_dep_label.cc "example_dep_label.cc" (for labels)
*/
namespace paludis
{
extern template class PALUDIS_VISIBLE Cloneable<DepSpec>;
extern template class Pimp<ConditionalDepSpec>;
extern template class PALUDIS_VISIBLE CloneUsingThis<DepSpec, ConditionalDepSpec>;
extern template class Pimp<PackageDepSpec>;
extern template class PALUDIS_VISIBLE CloneUsingThis<DepSpec, PackageDepSpec>;
extern template class Pimp<DependenciesLabelsDepSpec>;
extern template class Pimp<URILabelsDepSpec>;
extern template class Pimp<PlainTextLabelDepSpec>;
/**
* Base class for a dependency spec.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE DepSpec :
public virtual Cloneable<DepSpec>
{
private:
Pimp<DepSpec> _imp;
protected:
DepSpec();
public:
///\name Basic operations
///\{
virtual ~DepSpec();
DepSpec(const DepSpec &) = delete;
DepSpec & operator= (const DepSpec &) = delete;
///\}
/**
* Our annotations, may be null.
*
* \since 0.58
*/
virtual const std::shared_ptr<const DepSpecAnnotations> maybe_annotations() const PALUDIS_ATTRIBUTE((warn_unused_result));
/**
* Change our annotations, may be null.
*
* \since 0.58
*/
virtual void set_annotations(const std::shared_ptr<const DepSpecAnnotations> &);
};
/**
* Represents a "|| ( )" dependency block.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE AnyDepSpec :
public DepSpec
{
public:
///\name Basic operations
///\{
AnyDepSpec();
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* Represents a ( first second third ) or top level group of dependency
* specs.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE AllDepSpec :
public DepSpec
{
public:
///\name Basic operations
///\{
AllDepSpec();
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* Represents a ^^ ( first second third ) group of requirements.
*
* \ingroup g_dep_spec
* \nosubgrouping
* \since 0.56
*/
class PALUDIS_VISIBLE ExactlyOneDepSpec :
public DepSpec
{
public:
///\name Basic operations
///\{
ExactlyOneDepSpec();
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* Represents a ?? ( first second third ) group of requirements.
*
* \ingroup g_dep_spec
* \nosubgrouping
* \since 0.56
*/
class PALUDIS_VISIBLE AtMostOneDepSpec :
public DepSpec
{
public:
///\name Basic operations
///\{
AtMostOneDepSpec();
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* Represents a dependency spec whose children should only be considered
* upon a certain condition (for example, a use dependency block).
*
* \ingroup g_dep_spec
* \since 0.26
* \nosubgrouping
*/
class PALUDIS_VISIBLE ConditionalDepSpec :
public DepSpec,
public CloneUsingThis<DepSpec, ConditionalDepSpec>
{
friend std::ostream & operator<< (std::ostream &, const ConditionalDepSpec &);
private:
Pimp<ConditionalDepSpec> _imp;
std::string _as_string() const;
public:
///\name Basic operations
///\{
ConditionalDepSpec(const std::shared_ptr<const ConditionalDepSpecData> &);
ConditionalDepSpec(const ConditionalDepSpec &);
~ConditionalDepSpec();
///\}
/**
* Is our condition met?
*
* This takes into account inverses etc.
*
* \since 0.58 takes env, package_id
*/
bool condition_met(
const Environment * const,
const std::shared_ptr<const PackageID> &) const PALUDIS_ATTRIBUTE((warn_unused_result));
/**
* Would our condition met, if certain choices were changed?
*
* \since 0.58 takes env, package_id
*/
bool condition_would_be_met_when(
const Environment * const,
const std::shared_ptr<const PackageID> &,
const ChangedChoices &) const PALUDIS_ATTRIBUTE((warn_unused_result));
/**
* Is our condition meetable?
*
* This takes into account inverses, masks, forces etc.
*
* \since 0.58 takes env, package_id
*/
bool condition_meetable(
const Environment * const,
const std::shared_ptr<const PackageID> &) const PALUDIS_ATTRIBUTE((warn_unused_result));
/**
* Fetch our data.
*
* This shouldn't generally be used by clients, but some repositories use it
* to gain access to additional data stored in the ConditionalDepSpecData.
*/
const std::shared_ptr<const ConditionalDepSpecData> data() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* A StringDepSpec represents a dep spec with an associated piece of text.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE StringDepSpec :
public DepSpec
{
private:
std::string _str;
protected:
///\name Basic operations
///\{
StringDepSpec(const std::string &);
~StringDepSpec();
///\}
/**
* Change our text.
*/
void set_text(const std::string &);
public:
/**
* Fetch our text.
*/
std::string text() const;
};
namespace n
{
typedef Name<struct name_include_masked> include_masked;
typedef Name<struct name_path> path;
typedef Name<struct name_repository> repository;
}
/**
* Data for PackageDepSpec.installable_to_repository_ptr() etc.
*
* \ingroup g_dep_spec
* \since 0.32
*/
struct InstallableToRepository
{
NamedValue<n::include_masked, bool> include_masked;
NamedValue<n::repository, RepositoryName> repository;
};
/**
* Data for PackageDepSpec.installable_to_path_ptr() etc.
*
* \ingroup g_dep_spec
* \since 0.32
*/
struct InstallableToPath
{
NamedValue<n::include_masked, bool> include_masked;
NamedValue<n::path, FSPath> path;
};
/**
* A PackageDepSpec represents a package name (for example,
* 'app-editors/vim'), possibly with associated version and SLOT
* restrictions.
*
* A PackageDepSpec is implemented in terms of PackageDepSpecData. Individual
* repositories provide their own way of creating PackageDepSpec::Data that
* handle the native syntax for those repositories (e.g. CRAN uses
* "Blah (>= 1.23)" whilst E uses ">=cat/blah-1.23").
*
* To create a PackageDepSpec from user input, use
* parse_user_package_dep_spec(), and for programmer input, use
* make_package_dep_spec().
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE PackageDepSpec :
public StringDepSpec,
public CloneUsingThis<DepSpec, PackageDepSpec>
{
friend std::ostream & operator<< (std::ostream &, const PackageDepSpec &);
private:
const PackageDepSpec & operator= (const PackageDepSpec &);
std::string _as_string() const;
Pimp<PackageDepSpec> _imp;
public:
///\name Basic operations
///\{
/**
* Constructor.
*
* Clients will usually use either parse_user_package_dep_spec() or
* make_package_dep_spec() rather than calling this method
* directly. Repositories will define their own way of creating
* a PackageDepSpec.
*
* \since 0.26
*/
PackageDepSpec(const std::shared_ptr<const PackageDepSpecData> &);
PackageDepSpec(const PackageDepSpec &);
~PackageDepSpec();
///\}
/**
* Fetch the package name (may be a zero pointer).
*/
std::shared_ptr<const QualifiedPackageName> package_ptr() const;
/**
* Fetch the package name part, if wildcarded, or a zero pointer otherwise.
*/
std::shared_ptr<const PackageNamePart> package_name_part_ptr() const;
/**
* Fetch the category name part, if wildcarded, or a zero pointer otherwise.
*/
std::shared_ptr<const CategoryNamePart> category_name_part_ptr() const;
/**
* Fetch the version requirements (may be a zero pointer).
*/
std::shared_ptr<const VersionRequirements> version_requirements_ptr() const;
/**
* Fetch the version requirements mode.
*/
VersionRequirementsMode version_requirements_mode() const;
/**
* Fetch the slot requirement (may be a zero pointer).
*/
std::shared_ptr<const SlotRequirement> slot_requirement_ptr() const;
/**
* Fetch the in-repository requirement (may be a zero pointer).
*/
std::shared_ptr<const RepositoryName> in_repository_ptr() const;
/**
* Fetch the installable-to-repository requirement (may be a zero pointer).
*
* \since 0.32
*/
std::shared_ptr<const InstallableToRepository> installable_to_repository_ptr() const;
/**
* Fetch the from-repository requirement (may be a zero pointer).
*/
std::shared_ptr<const RepositoryName> from_repository_ptr() const;
/**
* Fetch the installed-at-path requirement (may be a zero pointer).
*
* \since 0.32
*/
std::shared_ptr<const FSPath> installed_at_path_ptr() const;
/**
* Fetch the installable-to-path requirement (may be a zero pointer).
*
* \since 0.32
*/
std::shared_ptr<const InstallableToPath> installable_to_path_ptr() const;
/**
* Fetch any additional requirements (may be a zero pointer).
*/
std::shared_ptr<const AdditionalPackageDepSpecRequirements> additional_requirements_ptr() const;
/**
* Access to our data.
*/
std::shared_ptr<const PackageDepSpecData> data() const;
};
/**
* A PlainTextDepSpec represents a plain text entry.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE PlainTextDepSpec :
public StringDepSpec
{
public:
///\name Basic operations
///\{
PlainTextDepSpec(const std::string &);
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* A NamedSetDepSpec represents a named package set.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE NamedSetDepSpec :
public StringDepSpec
{
private:
const SetName _name;
public:
///\name Basic operations
///\{
NamedSetDepSpec(const SetName &);
///\}
/// Fetch the name of our set.
const SetName name() const PALUDIS_ATTRIBUTE((warn_unused_result));
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* A LicenseDepSpec represents a license entry.
*
* \ingroup g_dep_spec
* \since 0.26
* \nosubgrouping
*/
class PALUDIS_VISIBLE LicenseDepSpec :
public StringDepSpec
{
public:
///\name Basic operations
///\{
LicenseDepSpec(const std::string &);
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* A FetchableURIDepSpec represents a fetchable URI part.
*
* It differs from a SimpleURIDepSpec in that it supports arrow notation. Arrows
* are used by exheres to allow downloading to a filename other than that used by
* the original URL.
*
* \ingroup g_dep_spec
* \since 0.26
* \nosubgrouping
*/
class PALUDIS_VISIBLE FetchableURIDepSpec :
public StringDepSpec
{
public:
///\name Basic operations
///\{
FetchableURIDepSpec(const std::string &);
///\}
/**
* The original URL (that is, the text to the left of the arrow, if present,
* or the entire text otherwise).
*/
std::string original_url() const;
/**
* The renamed URL filename (that is, the text to the right of the arrow,
* if present, or an empty string otherwise).
*/
std::string renamed_url_suffix() const;
/**
* The filename (that is, the renamed URL suffix, if present, or the text
* after the final / in the original URL otherwise).
*/
std::string filename() const;
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* A SimpleURIDepSpec represents a simple URI part.
*
* Unlike FetchableURIDepSpec, arrow notation is not supported.
*
* \ingroup g_dep_spec
* \since 0.26
* \nosubgrouping
*/
class PALUDIS_VISIBLE SimpleURIDepSpec :
public StringDepSpec
{
public:
///\name Basic operations
///\{
SimpleURIDepSpec(const std::string &);
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* Thrown if an invalid package dep spec specification is encountered.
*
* \ingroup g_exceptions
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE PackageDepSpecError :
public Exception
{
public:
///\name Basic operations
///\{
PackageDepSpecError(const std::string & msg) noexcept;
///\}
};
/**
* A BlockDepSpec represents a block on a package name (for example,
* 'app-editors/vim'), possibly with associated version and SLOT
* restrictions.
*
* \ingroup g_dep_spec
* \nosubgrouping
*/
class PALUDIS_VISIBLE BlockDepSpec :
public StringDepSpec
{
private:
PackageDepSpec _spec;
public:
///\name Basic operations
///\{
BlockDepSpec(const std::string & text, const PackageDepSpec & spec);
BlockDepSpec(const BlockDepSpec &);
///\}
/**
* Fetch the spec we're blocking.
*
* \since 0.41
*/
const PackageDepSpec blocking() const PALUDIS_ATTRIBUTE((warn_unused_result));
/**
* Our annotations, may be null. Forwards to the
* underlying PackageDepSpec.
*
* \since 0.73
*/
virtual const std::shared_ptr<const DepSpecAnnotations> maybe_annotations() const PALUDIS_ATTRIBUTE((warn_unused_result));
/**
* Change our annotations, may be null. Forwards to the
* underlying PackageDepSpec.
*
* \since 0.73
*/
virtual void set_annotations(const std::shared_ptr<const DepSpecAnnotations> &);
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
/**
* A LabelsDepSpec represents a labels entry using a particular visitor
* types class.
*
* \see DependencyLabelsDepSpec
* \see URILabelsDepSpec
* \since 0.26
* \ingroup g_dep_spec
* \nosubgrouping
*/
template <typename Labels_>
class PALUDIS_VISIBLE LabelsDepSpec :
public DepSpec
{
private:
Pimp<LabelsDepSpec> _imp;
public:
///\name Basic operations
///\{
LabelsDepSpec();
~LabelsDepSpec();
///\}
///\name Contained labels
///\{
void add_label(const std::shared_ptr<const Labels_> &);
struct ConstIteratorTag;
typedef WrappedForwardIterator<ConstIteratorTag,
const std::shared_ptr<const Labels_> > ConstIterator;
ConstIterator begin() const PALUDIS_ATTRIBUTE((warn_unused_result));
ConstIterator end() const PALUDIS_ATTRIBUTE((warn_unused_result));
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
class PALUDIS_VISIBLE PlainTextLabelDepSpec :
public StringDepSpec
{
public:
///\name Basic operations
///\{
PlainTextLabelDepSpec(const std::string &);
~PlainTextLabelDepSpec();
///\}
virtual std::shared_ptr<DepSpec> clone() const PALUDIS_ATTRIBUTE((warn_unused_result));
const std::string label() const PALUDIS_ATTRIBUTE((warn_unused_result));
};
extern template class PALUDIS_VISIBLE WrappedForwardIterator<DependenciesLabelsDepSpec::ConstIteratorTag,
const std::shared_ptr<const DependenciesLabel> >;
extern template class PALUDIS_VISIBLE WrappedForwardIterator<URILabelsDepSpec::ConstIteratorTag,
const std::shared_ptr<const URILabel> >;
}
#endif
Reference in New Issue View Git Blame Copy Permalink