]>
Commit | Line | Data |
---|---|---|
0e5943eb JF |
1 | // -*- mode: cpp; mode: fold -*- |
2 | // Description /*{{{*/ | |
3 | /** \class APT::Configuration | |
4 | * \brief Provide access methods to various configuration settings | |
5 | * | |
6 | * This class and their methods providing a layer around the usual access | |
7 | * methods with _config to ensure that settings are correct and to be able | |
8 | * to set defaults without the need to recheck it in every method again. | |
9 | */ | |
10 | /*}}}*/ | |
11 | #ifndef APT_CONFIGURATION_H | |
12 | #define APT_CONFIGURATION_H | |
13 | // Include Files /*{{{*/ | |
14 | #include <string> | |
15 | #include <vector> | |
16 | /*}}}*/ | |
17 | namespace APT { | |
18 | class Configuration { /*{{{*/ | |
19 | public: /*{{{*/ | |
20 | /** \brief Returns a vector of usable Compression Types | |
21 | * | |
22 | * Files can be compressed in various ways to decrease the size of the | |
23 | * download. Therefore the Acquiremethods support a few compression types | |
24 | * and some archives provide also a few different types. This option | |
25 | * group exists to give the user the choice to prefer one type over the | |
26 | * other (some compression types are very resource intensive - great if you | |
27 | * have a limited download, bad if you have a really lowpowered hardware.) | |
28 | * | |
29 | * This method ensures that the defaults are set and checks at runtime | |
30 | * if the type can be used. E.g. the current default is to prefer bzip2 | |
31 | * over lzma and gz - if the bzip2 binary is not available it has not much | |
32 | * sense in downloading the bz2 file, therefore we will not return bz2 as | |
33 | * a usable compression type. The availability is checked with the settings | |
34 | * in the Dir::Bin group. | |
35 | * | |
36 | * \param Cached saves the result so we need to calculated it only once | |
37 | * this parameter should ony be used for testing purposes. | |
38 | * | |
39 | * \return a vector of (all) Language Codes in the prefered usage order | |
40 | */ | |
41 | std::vector<std::string> static const getCompressionTypes(bool const &Cached = true); | |
42 | /*}}}*/ | |
43 | }; | |
44 | /*}}}*/ | |
45 | } | |
46 | #endif |