Imported Upstream version 14.45.0

[platform/upstream/libzypp.git] / zypp / Target.h

diff --git a/zypp/Target.h b/zypp/Target.h
index 2dd9d3c..10f1119 100644 (file)
--- a/zypp/Target.h
+++ b/zypp/Target.h
@@ -17,7 +17,7 @@
 #include "zypp/base/ReferenceCounted.h"
 #include "zypp/base/NonCopyable.h"
 #include "zypp/base/PtrTypes.h"
-#include "zypp/base/Deprecated.h"
+#include "zypp/APIConfig.h"
 
 #include "zypp/Product.h"
 #include "zypp/Pathname.h"
@@ -70,16 +70,14 @@ namespace zypp
      */
     void load();
 
+    void reload();
+    
     /**
      * unload target resolvables from the
      * pool
      */
     void unload();
 
-    /** \deprecated NOOP
-    */
-    ZYPP_DEPRECATED void reset() {}
-
     /** Null implementation */
     static Target_Ptr nullimpl();
 
@@ -118,49 +116,79 @@ namespace zypp
      * if you require some base product attributes when the
      * target is not loaded into the pool, see
      * \ref targetDistribution , \ref targetDistributionRelease
-     * and \ref distributionVersion that obtain the data 
+     * and \ref distributionVersion that obtain the data
      * on demand from the installed product information.
      */
     Product::constPtr baseProduct() const;
 
-    /** \name Base product and registration. */
-    //@{
-    /** The targets distribution release string (/etc/SuSE-release)
-     * \code
-     *   openSUSE 10.3 (i586)
-     * \endcode
-     * \deprecated \ref targetDistribution might be a better choice as it does not depend on /etc/SuSE-release.
-    */
-    std::string release() const ZYPP_DEPRECATED;
+    /**
+     * \brief Languages to be supported by the system.
+     * E.g. language specific packages to be installed.
+     */
+    LocaleSet requestedLocales() const;
+    /** \overload Use a specific root_r, if empty the default targets root, or '/'
+     */
+    static LocaleSet requestedLocales( const Pathname & root_r );
 
+  public:
+    /** \name Base product and registration.
+     *
+     * Static methods herein allow to retrieve the values without explicitly
+     * initializing the \ref Target. They take a targets root directory as
+     * argument. If an empty \ref Pathname is passed, an already existing
+     * Targets root is used, otherwise \c "/" is assumed.
+     */
+    //@{
     /** This is \c register.target attribute of the installed base product.
      * Used for registration and \ref Service refresh.
      */
     std::string targetDistribution() const;
+    /** \overload */
+    static std::string targetDistribution( const Pathname & root_r );
 
     /** This is \c register.release attribute of the installed base product.
      * Used for registration.
      */
     std::string targetDistributionRelease() const;
-    //@}
+    /** \overload */
+    static std::string targetDistributionRelease( const Pathname & root_r );
+
+    /** This is \c register.flavor attribute of the installed base product.
+     * Used for registration.
+     * \note don't mistake this for \ref distributionFlavor
+     */
+    std::string targetDistributionFlavor() const;
+    /** \overload */
+    static std::string targetDistributionFlavor( const Pathname & root_r );
+
+    struct DistributionLabel { std::string shortName; std::string summary; };
+    /** This is \c shortName and \c summary attribute of the installed base product.
+     * Used e.g. for the bootloader menu.
+     */
+    DistributionLabel distributionLabel() const;
+    /** \overload */
+    static DistributionLabel distributionLabel( const Pathname & root_r );
 
     /** This is \c version attribute of the installed base product.
      * For example http://download.opensue.org/update/11.0
      * The 11.0 corresponds to the base product version.
      */
     std::string distributionVersion() const;
-    //@}
-    
+    /** \overload */
+    static std::string distributionVersion( const Pathname & root_r );
 
     /**
-     * This is \flavor attribute of the installed base product
+     * This is \c flavor attribute of the installed base product
      * but does not require the target to be loaded as it remembers
      * the last used one. It can be empty is the target has never
      * been loaded, as the value is not present in the system
      * but computer from a package provides
+     * \note don't mistake this for \ref targetDistributionFlavor
      */
-    std::string distributionFlavor() const;    
-    
+    std::string distributionFlavor() const;
+    /** \overload */
+    static std::string distributionFlavor( const Pathname & root_r );
+
     /**
      * anonymous unique id
      *
@@ -170,6 +198,9 @@ namespace zypp
      *
      */
     std::string anonymousUniqueId() const;
+    /** \overload */
+    static std::string anonymousUniqueId( const Pathname & root_r );
+    //@}
 
   public:
     /** Ctor. If \c doRebuild_r is \c true, an already existing
@@ -201,6 +232,14 @@ namespace zypp
   inline std::ostream & operator<<( std::ostream & str, const Target & obj )
   { return obj.dumpOn( str ); }
 
+  /** \relates Target::DistributionLabel Stream output.
+   * Write out the content as key/value pairs:
+   * \code
+   * summary=Beautiful Name
+   * shortName=BN
+   * \endcode
+   */
+  std::ostream & operator<<( std::ostream & str, const Target::DistributionLabel & obj );
 
   /////////////////////////////////////////////////////////////////
 } // namespace zypp