literal_metadata_key.hh

Go to the documentation of this file.
00001 /* vim: set sw=4 sts=4 et foldmethod=syntax : */
00002 
00003 /*
00004  * Copyright (c) 2007, 2008, 2009 Ciaran McCreesh
00005  *
00006  * This file is part of the Paludis package manager. Paludis is free software;
00007  * you can redistribute it and/or modify it under the terms of the GNU General
00008  * Public License version 2, as published by the Free Software Foundation.
00009  *
00010  * Paludis is distributed in the hope that it will be useful, but WITHOUT ANY
00011  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00012  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00013  * details.
00014  *
00015  * You should have received a copy of the GNU General Public License along with
00016  * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00017  * Place, Suite 330, Boston, MA  02111-1307  USA
00018  */
00019 
00020 #ifndef PALUDIS_GUARD_PALUDIS_LITERAL_METADATA_KEY_HH
00021 #define PALUDIS_GUARD_PALUDIS_LITERAL_METADATA_KEY_HH 1
00022 
00023 #include <paludis/metadata_key.hh>
00024 #include <paludis/util/fs_entry.hh>
00025 #include <paludis/util/private_implementation_pattern.hh>
00026 #include <paludis/util/sequence.hh>
00027 #include <paludis/util/set.hh>
00028 
00029 /** \file
00030  * Declarations for literal metadata key classes.
00031  *
00032  * \ingroup g_literal_metadata_key
00033  *
00034  * \section Examples
00035  *
00036  * - \ref example_metadata_key.cc "example_metadata_key.cc" (for metadata keys)
00037  */
00038 
00039 
00040 namespace paludis
00041 {
00042     /**
00043      * Implement extra methods for LiteralMetadataValueKey.
00044      *
00045      * \ingroup g_metadata_key
00046      * \since 0.26
00047      */
00048     template <typename T_>
00049     class ExtraLiteralMetadataValueKeyMethods
00050     {
00051     };
00052 
00053     /**
00054      * Implement extra methods for LiteralMetadataValueKey for PackageID.
00055      *
00056      * \ingroup g_metadata_key
00057      * \since 0.26
00058      */
00059     template <>
00060     class PALUDIS_VISIBLE ExtraLiteralMetadataValueKeyMethods<std::tr1::shared_ptr<const PackageID> > :
00061         public virtual ExtraMetadataValueKeyMethods<std::tr1::shared_ptr<const PackageID> >
00062     {
00063         public:
00064             virtual ~ExtraLiteralMetadataValueKeyMethods() = 0;
00065 
00066             virtual std::string pretty_print(const Formatter<PackageID> &) const
00067                 PALUDIS_ATTRIBUTE((warn_unused_result));
00068     };
00069 
00070     /**
00071      * Implement extra methods for LiteralMetadataValueKey for long.
00072      *
00073      * \ingroup g_metadata_key
00074      * \since 0.28
00075      */
00076     template <>
00077     class PALUDIS_VISIBLE ExtraLiteralMetadataValueKeyMethods<long> :
00078         public virtual ExtraMetadataValueKeyMethods<long>
00079     {
00080         public:
00081             virtual ~ExtraLiteralMetadataValueKeyMethods() = 0;
00082 
00083             virtual std::string pretty_print() const
00084                 PALUDIS_ATTRIBUTE((warn_unused_result));
00085     };
00086 
00087     /**
00088      * Implement extra methods for LiteralMetadataValueKey for bool.
00089      *
00090      * \ingroup g_metadata_key
00091      * \since 0.34.1
00092      */
00093     template <>
00094     class PALUDIS_VISIBLE ExtraLiteralMetadataValueKeyMethods<bool> :
00095         public virtual ExtraMetadataValueKeyMethods<bool>
00096     {
00097         public:
00098             virtual ~ExtraLiteralMetadataValueKeyMethods() = 0;
00099 
00100             virtual std::string pretty_print() const
00101                 PALUDIS_ATTRIBUTE((warn_unused_result));
00102     };
00103 
00104     /**
00105      * A LiteralMetadataValueKey is a MetadataValueKey whose value is a
00106      * copyable literal that is known at construction time.
00107      *
00108      * \ingroup g_literal_metadata_key
00109      * \since 0.26
00110      */
00111     template <typename T_>
00112     class PALUDIS_VISIBLE LiteralMetadataValueKey :
00113         public MetadataValueKey<T_>,
00114         private PrivateImplementationPattern<LiteralMetadataValueKey<T_> >,
00115         public ExtraLiteralMetadataValueKeyMethods<T_>
00116     {
00117         private:
00118             typename PrivateImplementationPattern<LiteralMetadataValueKey<T_> >::ImpPtr & _imp;
00119 
00120         public:
00121             ///\name Basic operations
00122             ///\{
00123 
00124             LiteralMetadataValueKey(const std::string &, const std::string &, const MetadataKeyType,
00125                     const T_ &);
00126             ~LiteralMetadataValueKey();
00127 
00128             ///\}
00129 
00130             virtual const T_ value() const PALUDIS_ATTRIBUTE((warn_unused_result));
00131 
00132             virtual const std::string raw_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00133             virtual const std::string human_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00134             virtual MetadataKeyType type() const PALUDIS_ATTRIBUTE((warn_unused_result));
00135 
00136             /**
00137              * \since 0.36
00138              */
00139             void change_value(const T_ &);
00140     };
00141 
00142     /**
00143      * A LiteralMetadataFSEntrySequenceKey is a MetadataCollectionKey<FSEntrySequence>
00144      * whose value is known at construction time.
00145      *
00146      * \ingroup g_literal_metadata_key
00147      * \since 0.26
00148      */
00149     class PALUDIS_VISIBLE LiteralMetadataFSEntrySequenceKey :
00150         public MetadataCollectionKey<FSEntrySequence>,
00151         private PrivateImplementationPattern<LiteralMetadataFSEntrySequenceKey>
00152     {
00153         private:
00154             PrivateImplementationPattern<LiteralMetadataFSEntrySequenceKey>::ImpPtr & _imp;
00155 
00156         public:
00157             ///\name Basic operations
00158             ///\{
00159 
00160             LiteralMetadataFSEntrySequenceKey(const std::string &, const std::string &, const MetadataKeyType,
00161                     const std::tr1::shared_ptr<const FSEntrySequence> &);
00162             ~LiteralMetadataFSEntrySequenceKey();
00163 
00164             ///\}
00165 
00166             virtual const std::tr1::shared_ptr<const FSEntrySequence> value() const PALUDIS_ATTRIBUTE((warn_unused_result));
00167 
00168             virtual std::string pretty_print_flat(const Formatter<FSEntry> &) const
00169                 PALUDIS_ATTRIBUTE((warn_unused_result));
00170 
00171             virtual const std::string raw_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00172             virtual const std::string human_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00173             virtual MetadataKeyType type() const PALUDIS_ATTRIBUTE((warn_unused_result));
00174     };
00175 
00176     /**
00177      * A LiteralMetadataStringSetKey is a MetadataCollectionKey<Set<std::string> >
00178      * whose value is known at construction time.
00179      *
00180      * \ingroup g_literal_metadata_key
00181      * \since 0.26
00182      */
00183     class PALUDIS_VISIBLE LiteralMetadataStringSetKey :
00184         public MetadataCollectionKey<Set<std::string> >,
00185         private PrivateImplementationPattern<LiteralMetadataStringSetKey>
00186     {
00187         private:
00188             PrivateImplementationPattern<LiteralMetadataStringSetKey>::ImpPtr & _imp;
00189 
00190         public:
00191             ///\name Basic operations
00192             ///\{
00193 
00194             LiteralMetadataStringSetKey(const std::string &, const std::string &, const MetadataKeyType,
00195                     const std::tr1::shared_ptr<const Set<std::string> > &);
00196             ~LiteralMetadataStringSetKey();
00197 
00198             ///\}
00199 
00200             virtual const std::tr1::shared_ptr<const Set<std::string> > value() const PALUDIS_ATTRIBUTE((warn_unused_result));
00201 
00202             virtual std::string pretty_print_flat(const Formatter<std::string> &) const
00203                 PALUDIS_ATTRIBUTE((warn_unused_result));
00204 
00205             virtual const std::string raw_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00206             virtual const std::string human_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00207             virtual MetadataKeyType type() const PALUDIS_ATTRIBUTE((warn_unused_result));
00208     };
00209 
00210     /**
00211      * A LiteralMetadataStringSequenceKey is a MetadataCollectionKey<Sequence<std::string> >
00212      * whose value is known at construction time.
00213      *
00214      * \ingroup g_literal_metadata_key
00215      * \since 0.30
00216      */
00217     class PALUDIS_VISIBLE LiteralMetadataStringSequenceKey :
00218         public MetadataCollectionKey<Sequence<std::string> >,
00219         private PrivateImplementationPattern<LiteralMetadataStringSequenceKey>
00220     {
00221         private:
00222             PrivateImplementationPattern<LiteralMetadataStringSequenceKey>::ImpPtr & _imp;
00223 
00224         public:
00225             ///\name Basic operations
00226             ///\{
00227 
00228             LiteralMetadataStringSequenceKey(const std::string &, const std::string &, const MetadataKeyType,
00229                     const std::tr1::shared_ptr<const Sequence<std::string> > &);
00230             ~LiteralMetadataStringSequenceKey();
00231 
00232             ///\}
00233 
00234             virtual const std::tr1::shared_ptr<const Sequence<std::string> > value() const PALUDIS_ATTRIBUTE((warn_unused_result));
00235 
00236             virtual std::string pretty_print_flat(const Formatter<std::string> &) const
00237                 PALUDIS_ATTRIBUTE((warn_unused_result));
00238 
00239             virtual const std::string raw_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00240             virtual const std::string human_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00241             virtual MetadataKeyType type() const PALUDIS_ATTRIBUTE((warn_unused_result));
00242     };
00243 
00244     /**
00245      * A LiteralMetadataTimeKey is a MetadataTimeKey whose value is known at
00246      * construction time.
00247      *
00248      * \ingroup g_literal_metadata_key
00249      * \since 0.36
00250      */
00251     class PALUDIS_VISIBLE LiteralMetadataTimeKey :
00252         public MetadataTimeKey,
00253         private PrivateImplementationPattern<LiteralMetadataTimeKey>
00254     {
00255         private:
00256             PrivateImplementationPattern<LiteralMetadataTimeKey>::ImpPtr & _imp;
00257 
00258         public:
00259             ///\name Basic operations
00260             ///\{
00261 
00262             LiteralMetadataTimeKey(const std::string &, const std::string &, const MetadataKeyType, const time_t);
00263             ~LiteralMetadataTimeKey();
00264 
00265             ///\}
00266 
00267             virtual time_t value() const PALUDIS_ATTRIBUTE((warn_unused_result));
00268 
00269             virtual const std::string raw_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00270             virtual const std::string human_name() const PALUDIS_ATTRIBUTE((warn_unused_result));
00271             virtual MetadataKeyType type() const PALUDIS_ATTRIBUTE((warn_unused_result));
00272     };
00273 }
00274 
00275 #endif

Generated on Mon Sep 21 10:36:08 2009 for paludis by  doxygen 1.5.4