about_metadata.hh

Go to the documentation of this file.

/* vim: set sw=4 sts=4 et foldmethod=syntax : */
 
/*
 * Copyright (c) 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_ABOUT_METADATA_HH
#define PALUDIS_GUARD_PALUDIS_ABOUT_METADATA_HH 1
 
#include <paludis/about_metadata-fwd.hh>
#include <paludis/util/attributes.hh>
#include <paludis/util/pimp.hh>
#include <paludis/util/singleton.hh>
#include <paludis/metadata_key_holder.hh>
 
/** \file
 * Provides information about Paludis, similar to that in "paludis/about.hh", in
 * the form of MetadataKey values.
 *
 * \ingroup g_about
 */
 
namespace paludis
{
    extern template class PALUDIS_VISIBLE Singleton<AboutMetadata>;
 
    /**
     * Information about Paludis, provided as MetadataKey instances.
     *
     * \ingroup g_about
     * \since 0.46
     */
    class PALUDIS_VISIBLE AboutMetadata :
        public Singleton<AboutMetadata>,
        public MetadataKeyHolder
    {
        friend class Singleton<AboutMetadata>;
 
        private:
            Pimp<AboutMetadata> _imp;
 
            AboutMetadata();
            ~AboutMetadata() override;
 
        protected:
            void need_keys_added() const override;
    };
 
    extern template class Pimp<AboutMetadata>;
}
 
#endif