Refactor the cache iterators by using a common base class

[apt.git] / apt-pkg / aptconfiguration.h

diff --git a/apt-pkg/aptconfiguration.h b/apt-pkg/aptconfiguration.h
index 6a123adcede9376722e6f177aa8ded1be4afc346..f2f04a39bd840a9a6db6bfd28f9a935105593a81 100644 (file)
--- a/apt-pkg/aptconfiguration.h
+++ b/apt-pkg/aptconfiguration.h
@@ -39,6 +39,33 @@ public:                                                                      /*{{{*/
         *  \return a vector of (all) Language Codes in the prefered usage order
         */
        std::vector<std::string> static const getCompressionTypes(bool const &Cached = true);
         *  \return a vector of (all) Language Codes in the prefered usage order
         */
        std::vector<std::string> static const getCompressionTypes(bool const &Cached = true);

+
+       /** \brief Returns a vector of Language Codes
+        *
+        *  Languages can be defined with their two or five chars long code.
+        *  This methods handles the various ways to set the prefered codes,
+        *  honors the environment and ensures that the codes are not listed twice.
+        *
+        *  The special word "environment" will be replaced with the long and the short
+        *  code of the local settings and it will be insured that this will not add
+        *  duplicates. So in an german local the setting "environment, de_DE, en, de"
+        *  will result in "de_DE, de, en".
+        *
+        *  Another special word is "none" which separates the prefered from all codes
+        *  in this setting. So setting and method can be used to get codes the user want
+        *  to see or to get all language codes APT (should) have Translations available.
+        *
+        *  \param All return all codes or only codes for languages we want to use
+        *  \param Cached saves the result so we need to calculated it only once
+        *                this parameter should ony be used for testing purposes.
+        *  \param Locale don't get the locale from the system but use this one instead
+        *                this parameter should ony be used for testing purposes.
+        *
+        *  \return a vector of (all) Language Codes in the prefered usage order
+        */
+       std::vector<std::string> static const getLanguages(bool const &All = false,
+                       bool const &Cached = true, char const * const Locale = 0);
+

                                                                        /*}}}*/
 };
                                                                        /*}}}*/
                                                                        /*}}}*/
 };
                                                                        /*}}}*/