guard const-ification API changes

[apt.git] / apt-pkg / acquire-item.h

diff --git a/apt-pkg/acquire-item.h b/apt-pkg/acquire-item.h
index 0e7212fc55fd132eba5a7952a80538119471c3e3..1af737e00f07461bc11568f1702863bcc963cb48 100644 (file)
--- a/apt-pkg/acquire-item.h
+++ b/apt-pkg/acquire-item.h
@@ -63,6 +63,8 @@ class pkgAcqMetaBase;
  */
 class pkgAcquire::Item : public WeakPointable
 {  
  */
 class pkgAcquire::Item : public WeakPointable
 {  

+   friend class pkgAcqMetaBase;
+

    void *d;
 
    protected:
    void *d;
 
    protected:


@@ -252,7 +254,11 @@ class pkgAcquire::Item : public WeakPointable
     *  line, so they should (if nonempty) have a leading newline and
     *  no trailing newline.
     */
     *  line, so they should (if nonempty) have a leading newline and
     *  no trailing newline.
     */

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const {return std::string();};
    virtual std::string Custom600Headers() const {return std::string();};

+#else
+   virtual std::string Custom600Headers() {return std::string();};
+#endif

 
    /** \brief A "descriptive" URI-like string.
     *
 
    /** \brief A "descriptive" URI-like string.
     *


@@ -278,9 +284,16 @@ class pkgAcquire::Item : public WeakPointable
 
    /** \return the acquire process with which this item is associated. */
    pkgAcquire *GetOwner() const {return Owner;};
 
    /** \return the acquire process with which this item is associated. */
    pkgAcquire *GetOwner() const {return Owner;};

+#if APT_PKG_ABI < 413
+   pkgAcquire *GetOwner() {return Owner;};
+#endif

 
    /** \return \b true if this object is being fetched from a trusted source. */
 
    /** \return \b true if this object is being fetched from a trusted source. */

+#if APT_PKG_ABI >= 413

    virtual bool IsTrusted() const {return false;};
    virtual bool IsTrusted() const {return false;};

+#else
+   virtual bool IsTrusted() {return false;};
+#endif

    
    /** \brief Report mirror problem
     * 
    
    /** \brief Report mirror problem
     * 


@@ -323,6 +336,7 @@ class pkgAcquire::Item : public WeakPointable
       InvalidFormat,
       SignatureError,
       NotClearsigned,
       InvalidFormat,
       SignatureError,
       NotClearsigned,

+      MaximumSizeExceeded

    };
 
    /** \brief Rename failed file and set error
    };
 
    /** \brief Rename failed file and set error


@@ -339,7 +353,7 @@ class pkgAcquire::Item : public WeakPointable
 };
                                                                        /*}}}*/
 /** \brief Information about an index patch (aka diff). */             /*{{{*/
 };
                                                                        /*}}}*/
 /** \brief Information about an index patch (aka diff). */             /*{{{*/

-struct DiffInfo {
+struct APT_HIDDEN DiffInfo {

    /** The filename of the diff. */
    std::string file;
 
    /** The filename of the diff. */
    std::string file;
 


@@ -356,9 +370,7 @@ struct DiffInfo {
    unsigned long long patch_size;
 };
                                                                        /*}}}*/
    unsigned long long patch_size;
 };
                                                                        /*}}}*/

-                                                                       /*}}}*/
-
-class pkgAcqMetaBase  : public pkgAcquire::Item
+class pkgAcqMetaBase  : public pkgAcquire::Item                                /*{{{*/

 {
    void *d;
 
 {
    void *d;
 


@@ -390,7 +402,6 @@ class pkgAcqMetaBase  : public pkgAcquire::Item
     */
    void QueueIndexes(bool verify);
 
     */
    void QueueIndexes(bool verify);
 

-

    /** \brief Called when a file is finished being retrieved.
     *
     *  If the file was not downloaded to DestFile, a copy process is
    /** \brief Called when a file is finished being retrieved.
     *
     *  If the file was not downloaded to DestFile, a copy process is


@@ -407,6 +418,9 @@ class pkgAcqMetaBase  : public pkgAcquire::Item
    void QueueForSignatureVerify(const std::string &MetaIndexFile,
                                 const std::string &MetaIndexFileSignature);
 
    void QueueForSignatureVerify(const std::string &MetaIndexFile,
                                 const std::string &MetaIndexFileSignature);
 

+   /** \brief get the custom600 header for all pkgAcqMeta */
+   std::string GetCustom600Headers(const std::string &RealURI) const;
+

    /** \brief Called when authentication succeeded.
     *
     *  Sanity-checks the authenticated file, queues up the individual
    /** \brief Called when authentication succeeded.
     *
     *  Sanity-checks the authenticated file, queues up the individual


@@ -436,12 +450,12 @@ class pkgAcqMetaBase  : public pkgAcquire::Item
    bool TransactionHasError() APT_PURE;
    void CommitTransaction();
 
    bool TransactionHasError() APT_PURE;
    void CommitTransaction();
 

-   /** \brief Stage (queue) a copy action when the transaction is commited
+   /** \brief Stage (queue) a copy action when the transaction is committed

     */
    void TransactionStageCopy(Item *I,
                              const std::string &From, 
                              const std::string &To);
     */
    void TransactionStageCopy(Item *I,
                              const std::string &From, 
                              const std::string &To);

-   /** \brief Stage (queue) a removal action when the transaction is commited
+   /** \brief Stage (queue) a removal action when the transaction is committed

     */
    void TransactionStageRemoval(Item *I, const std::string &FinalFile);
 
     */
    void TransactionStageRemoval(Item *I, const std::string &FinalFile);
 


@@ -454,7 +468,7 @@ class pkgAcqMetaBase  : public pkgAcquire::Item
         MetaIndexParser(MetaIndexParser), IndexTargets(IndexTargets),
         AuthPass(false), IMSHit(false) {};
 };
         MetaIndexParser(MetaIndexParser), IndexTargets(IndexTargets),
         AuthPass(false), IMSHit(false) {};
 };

-
+                                                                       /*}}}*/

 /** \brief An acquire item that downloads the detached signature       {{{
  *  of a meta-index (Release) file, then queues up the release
  *  file itself.
 /** \brief An acquire item that downloads the detached signature       {{{
  *  of a meta-index (Release) file, then queues up the release
  *  file itself.


@@ -463,7 +477,7 @@ class pkgAcqMetaBase  : public pkgAcquire::Item
  *
  *  \sa pkgAcqMetaIndex
  */
  *
  *  \sa pkgAcqMetaIndex
  */

-class pkgAcqMetaSig : public pkgAcqMetaBase
+class APT_HIDDEN pkgAcqMetaSig : public pkgAcqMetaBase

 {
    void *d;
 
 {
    void *d;
 


@@ -494,7 +508,11 @@ class pkgAcqMetaSig : public pkgAcqMetaBase
    virtual void Done(std::string Message,unsigned long long Size,
                      HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual void Done(std::string Message,unsigned long long Size,
                      HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const;
    virtual std::string Custom600Headers() const;

+#else
+   virtual std::string Custom600Headers();
+#endif

    virtual std::string DescURI() {return RealURI; };
 
    /** \brief Create a new pkgAcqMetaSig. */
    virtual std::string DescURI() {return RealURI; };
 
    /** \brief Create a new pkgAcqMetaSig. */


@@ -507,7 +525,6 @@ class pkgAcqMetaSig : public pkgAcqMetaBase
    virtual ~pkgAcqMetaSig();
 };
                                                                        /*}}}*/
    virtual ~pkgAcqMetaSig();
 };
                                                                        /*}}}*/

-

 /** \brief An item that is responsible for downloading the meta-index  {{{
  *  file (i.e., Release) itself and verifying its signature.
  *
 /** \brief An item that is responsible for downloading the meta-index  {{{
  *  file (i.e., Release) itself and verifying its signature.
  *


@@ -518,7 +535,7 @@ class pkgAcqMetaSig : public pkgAcqMetaBase
  *  otherwise, the expected hashsums will be "" (causing the
  *  authentication of the index files to be bypassed).
  */
  *  otherwise, the expected hashsums will be "" (causing the
  *  authentication of the index files to be bypassed).
  */

-class pkgAcqMetaIndex : public pkgAcqMetaBase
+class APT_HIDDEN pkgAcqMetaIndex : public pkgAcqMetaBase

 {
    void *d;
 
 {
    void *d;
 


@@ -549,7 +566,11 @@ class pkgAcqMetaIndex : public pkgAcqMetaBase
    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const;
    virtual std::string Custom600Headers() const;

+#else
+   virtual std::string Custom600Headers();
+#endif

    virtual std::string DescURI() {return RealURI; };
    virtual void Finished();
 
    virtual std::string DescURI() {return RealURI; };
    virtual void Finished();
 


@@ -563,7 +584,7 @@ class pkgAcqMetaIndex : public pkgAcqMetaBase
 };
                                                                        /*}}}*/
 /** \brief An item repsonsible for downloading clearsigned metaindexes {{{*/
 };
                                                                        /*}}}*/
 /** \brief An item repsonsible for downloading clearsigned metaindexes {{{*/

-class pkgAcqMetaClearSig : public pkgAcqMetaIndex
+class APT_HIDDEN pkgAcqMetaClearSig : public pkgAcqMetaIndex

 {
    void *d;
 
 {
    void *d;
 


@@ -587,7 +608,11 @@ class pkgAcqMetaClearSig : public pkgAcqMetaIndex
 
 public:
    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
 
 public:
    virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const;
    virtual std::string Custom600Headers() const;

+#else
+   virtual std::string Custom600Headers();
+#endif

    virtual void Done(std::string Message,unsigned long long Size,
                      HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual void Done(std::string Message,unsigned long long Size,
                      HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);


@@ -602,8 +627,6 @@ public:
    virtual ~pkgAcqMetaClearSig();
 };
                                                                        /*}}}*/
    virtual ~pkgAcqMetaClearSig();
 };
                                                                        /*}}}*/

-
-

 /** \brief Common base class for all classes that deal with fetching   {{{
            indexes
  */
 /** \brief Common base class for all classes that deal with fetching   {{{
            indexes
  */


@@ -647,7 +670,7 @@ class pkgAcqBaseIndex : public pkgAcquire::Item
  *
  *  \sa pkgAcqIndexDiffs, pkgAcqIndex
  */
  *
  *  \sa pkgAcqIndexDiffs, pkgAcqIndex
  */

-class pkgAcqDiffIndex : public pkgAcqBaseIndex
+class APT_HIDDEN pkgAcqDiffIndex : public pkgAcqBaseIndex

 {
    void *d;
 
 {
    void *d;
 


@@ -675,7 +698,11 @@ class pkgAcqDiffIndex : public pkgAcqBaseIndex
    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual std::string DescURI() {return RealURI + "Index";};
    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual std::string DescURI() {return RealURI + "Index";};

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const;
    virtual std::string Custom600Headers() const;

+#else
+   virtual std::string Custom600Headers();
+#endif

 
    /** \brief Parse the Index file for a set of Packages diffs.
     *
 
    /** \brief Parse the Index file for a set of Packages diffs.
     *


@@ -720,7 +747,7 @@ class pkgAcqDiffIndex : public pkgAcqBaseIndex
  *
  *  \sa pkgAcqDiffIndex, pkgAcqIndex
  */
  *
  *  \sa pkgAcqDiffIndex, pkgAcqIndex
  */

-class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
+class APT_HIDDEN pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex

 {
    void *d;
 
 {
    void *d;
 


@@ -808,7 +835,7 @@ class pkgAcqIndexMergeDiffs : public pkgAcqBaseIndex
  *
  *  \sa pkgAcqDiffIndex, pkgAcqIndex
  */
  *
  *  \sa pkgAcqDiffIndex, pkgAcqIndex
  */

-class pkgAcqIndexDiffs : public pkgAcqBaseIndex
+class APT_HIDDEN pkgAcqIndexDiffs : public pkgAcqBaseIndex

 {
    void *d;
 
 {
    void *d;
 


@@ -924,7 +951,7 @@ class pkgAcqIndexDiffs : public pkgAcqBaseIndex
  *
  *  \todo Why does pkgAcqIndex have protected members?
  */
  *
  *  \todo Why does pkgAcqIndex have protected members?
  */

-class pkgAcqIndex : public pkgAcqBaseIndex
+class APT_HIDDEN pkgAcqIndex : public pkgAcqBaseIndex

 {
    void *d;
 
 {
    void *d;
 


@@ -989,7 +1016,11 @@ class pkgAcqIndex : public pkgAcqBaseIndex
    virtual void Done(std::string Message,unsigned long long Size, 
                      HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual void Done(std::string Message,unsigned long long Size, 
                      HashStringList const &Hashes,
                     pkgAcquire::MethodConfig *Cnf);

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const;
    virtual std::string Custom600Headers() const;

+#else
+   virtual std::string Custom600Headers();
+#endif

    virtual std::string DescURI() {return Desc.URI;};
 
    /** \brief Create a pkgAcqIndex.
    virtual std::string DescURI() {return Desc.URI;};
 
    /** \brief Create a pkgAcqIndex.


@@ -1022,45 +1053,8 @@ class pkgAcqIndex : public pkgAcqBaseIndex
              std::string const &ShortDesc);
 };
                                                                        /*}}}*/
              std::string const &ShortDesc);
 };
                                                                        /*}}}*/

-/** \brief An acquire item that is responsible for fetching a          {{{
- *  translated index file.
- *
- *  The only difference from pkgAcqIndex is that transient failures
- *  are suppressed: no error occurs if the translated index file is
- *  missing.
- */
-class pkgAcqIndexTrans : public pkgAcqIndex
-{
-   void *d;
-
-   public:
-  
-   virtual void Failed(std::string Message,pkgAcquire::MethodConfig *Cnf);
-   virtual std::string Custom600Headers() const;
-
-   /** \brief Create a pkgAcqIndexTrans.
-    *
-    *  \param Owner The pkgAcquire object with which this item is
-    *  associated.
-    *
-    *  \param URI The URI of the index file that is to be downloaded.
-    *
-    *  \param URIDesc A "URI-style" description of this index file.
-    *
-    *  \param ShortDesc A brief description of this index file.
-    */
-   pkgAcqIndexTrans(pkgAcquire *Owner,
-                    std::string URI,std::string URIDesc,
-                   std::string ShortDesc);
-   pkgAcqIndexTrans(pkgAcquire *Owner,
-                    pkgAcqMetaBase *TransactionManager,
-                    IndexTarget const * const Target,
-                    HashStringList const &ExpectedHashes,
-                    indexRecords *MetaIndexParser);
-};
-                                                                       /*}}}*/

 /** \brief Information about an index file. */                         /*{{{*/
 /** \brief Information about an index file. */                         /*{{{*/

-class IndexTarget
+class APT_HIDDEN IndexTarget

 {
    void *d;
 
 {
    void *d;
 


@@ -1085,7 +1079,7 @@ class IndexTarget
 };
                                                                        /*}}}*/
 /** \brief Information about an optional index file. */                        /*{{{*/
 };
                                                                        /*}}}*/
 /** \brief Information about an optional index file. */                        /*{{{*/

-class OptionalIndexTarget : public IndexTarget
+class APT_HIDDEN OptionalIndexTarget : public IndexTarget

 {
    void *d;
 
 {
    void *d;
 


@@ -1148,8 +1142,12 @@ class pkgAcqArchive : public pkgAcquire::Item
    virtual std::string DescURI() {return Desc.URI;};
    virtual std::string ShortDesc() {return Desc.ShortDesc;};
    virtual void Finished();
    virtual std::string DescURI() {return Desc.URI;};
    virtual std::string ShortDesc() {return Desc.ShortDesc;};
    virtual void Finished();

+#if APT_PKG_ABI >= 413

    virtual bool IsTrusted() const;
    virtual bool IsTrusted() const;

-   
+#else
+   virtual bool IsTrusted();
+#endif
+

    /** \brief Create a new pkgAcqArchive.
     *
     *  \param Owner The pkgAcquire object with which this item is
    /** \brief Create a new pkgAcqArchive.
     *
     *  \param Owner The pkgAcquire object with which this item is


@@ -1198,7 +1196,11 @@ class pkgAcqFile : public pkgAcquire::Item
    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &CalcHashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual std::string DescURI() {return Desc.URI;};
    virtual void Done(std::string Message,unsigned long long Size, HashStringList const &CalcHashes,
                     pkgAcquire::MethodConfig *Cnf);
    virtual std::string DescURI() {return Desc.URI;};

+#if APT_PKG_ABI >= 413

    virtual std::string Custom600Headers() const;
    virtual std::string Custom600Headers() const;

+#else
+   virtual std::string Custom600Headers();
+#endif

 
    /** \brief Create a new pkgAcqFile object.
     *
 
    /** \brief Create a new pkgAcqFile object.
     *