drop confusing comma from no strong hash message

[apt.git] / apt-pkg / contrib / error.h

diff --git a/apt-pkg/contrib/error.h b/apt-pkg/contrib/error.h
index 7d09b2d4ad5320b3bb872879df08abd4acb2cadb..80d731ac96953770f680d75c67ace6ee5dafee81 100644 (file)
--- a/apt-pkg/contrib/error.h
+++ b/apt-pkg/contrib/error.h
@@ -46,6 +46,7 @@
 #include <list>
 #include <string>
 
 #include <list>
 #include <string>
 

+#include <stddef.h>

 #include <stdarg.h>
 
 class GlobalError                                                      /*{{{*/
 #include <stdarg.h>
 
 class GlobalError                                                      /*{{{*/


@@ -73,7 +74,7 @@ public:                                                                       /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool FatalE(const char *Function,const char *Description,...) __like_printf(3) __cold;
+       bool FatalE(const char *Function,const char *Description,...) APT_PRINTF(3) APT_COLD;

 
        /** \brief add an Error message with errno to the list
         *
 
        /** \brief add an Error message with errno to the list
         *


@@ -82,7 +83,7 @@ public:                                                                       /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool Errno(const char *Function,const char *Description,...) __like_printf(3) __cold;
+       bool Errno(const char *Function,const char *Description,...) APT_PRINTF(3) APT_COLD;

 
        /** \brief add a warning message with errno to the list
         *
 
        /** \brief add a warning message with errno to the list
         *


@@ -94,7 +95,7 @@ public:                                                                       /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool WarningE(const char *Function,const char *Description,...) __like_printf(3) __cold;
+       bool WarningE(const char *Function,const char *Description,...) APT_PRINTF(3) APT_COLD;

 
        /** \brief add a notice message with errno to the list
         *
 
        /** \brief add a notice message with errno to the list
         *


@@ -103,7 +104,7 @@ public:                                                                     /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool NoticeE(const char *Function,const char *Description,...) __like_printf(3) __cold;
+       bool NoticeE(const char *Function,const char *Description,...) APT_PRINTF(3) APT_COLD;

 
        /** \brief add a debug message with errno to the list
         *
 
        /** \brief add a debug message with errno to the list
         *


@@ -112,7 +113,7 @@ public:                                                                     /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool DebugE(const char *Function,const char *Description,...) __like_printf(3) __cold;
+       bool DebugE(const char *Function,const char *Description,...) APT_PRINTF(3) APT_COLD;

 
        /** \brief adds an errno message with the given type
         *
 
        /** \brief adds an errno message with the given type
         *


@@ -121,7 +122,7 @@ public:                                                                     /*{{{*/
         * \param Description of the error
         */
        bool InsertErrno(MsgType const &type, const char* Function,
         * \param Description of the error
         */
        bool InsertErrno(MsgType const &type, const char* Function,

-                        const char* Description,...) __like_printf(4) __cold;
+                        const char* Description,...) APT_PRINTF(4) APT_COLD;

 
        /** \brief adds an errno message with the given type
         *
 
        /** \brief adds an errno message with the given type
         *


@@ -140,14 +141,14 @@ public:                                                                   /*{{{*/
         */
        bool InsertErrno(MsgType type, const char* Function,
                         const char* Description, va_list &args,
         */
        bool InsertErrno(MsgType type, const char* Function,
                         const char* Description, va_list &args,

-                        int const errsv, size_t &msgSize);
+                        int const errsv, size_t &msgSize) APT_COLD;

 
        /** \brief add an fatal error message to the list
         *
         *  Most of the stuff we consider as "error" is also "fatal" for
         *  the user as the application will not have the expected result,
         *  but a fatal message here means that it gets printed directly
 
        /** \brief add an fatal error message to the list
         *
         *  Most of the stuff we consider as "error" is also "fatal" for
         *  the user as the application will not have the expected result,
         *  but a fatal message here means that it gets printed directly

-        *  to stderr in addiction to adding it to the list as the error
+        *  to stderr in addition to adding it to the list as the error

         *  leads sometimes to crashes and a maybe duplicated message
         *  is better than "Segfault" as the only displayed text
         *
         *  leads sometimes to crashes and a maybe duplicated message
         *  is better than "Segfault" as the only displayed text
         *


@@ -155,7 +156,7 @@ public:                                                                     /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool Fatal(const char *Description,...) __like_printf(2) __cold;
+       bool Fatal(const char *Description,...) APT_PRINTF(2) APT_COLD;

 
        /** \brief add an Error message to the list
         *
 
        /** \brief add an Error message to the list
         *


@@ -163,7 +164,7 @@ public:                                                                     /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool Error(const char *Description,...) __like_printf(2) __cold;
+       bool Error(const char *Description,...) APT_PRINTF(2) APT_COLD;

 
        /** \brief add a warning message to the list
         *
 
        /** \brief add a warning message to the list
         *


@@ -174,7 +175,7 @@ public:                                                                     /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool Warning(const char *Description,...) __like_printf(2) __cold;
+       bool Warning(const char *Description,...) APT_PRINTF(2) APT_COLD;

 
        /** \brief add a notice message to the list
         *
 
        /** \brief add a notice message to the list
         *


@@ -187,7 +188,7 @@ public:                                                                     /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool Notice(const char *Description,...) __like_printf(2) __cold;
+       bool Notice(const char *Description,...) APT_PRINTF(2) APT_COLD;

 
        /** \brief add a debug message to the list
         *
 
        /** \brief add a debug message to the list
         *


@@ -195,14 +196,14 @@ public:                                                                   /*{{{*/
         *
         *  \return \b false
         */
         *
         *  \return \b false
         */

-       bool Debug(const char *Description,...) __like_printf(2) __cold;
+       bool Debug(const char *Description,...) APT_PRINTF(2) APT_COLD;

 
        /** \brief adds an error message with the given type
         *
         * \param type of the error message
         * \param Description of the error
         */
 
        /** \brief adds an error message with the given type
         *
         * \param type of the error message
         * \param Description of the error
         */

-       bool Insert(MsgType const &type, const char* Description,...) __like_printf(3) __cold;
+       bool Insert(MsgType const &type, const char* Description,...) APT_PRINTF(3) APT_COLD;

 
        /** \brief adds an error message with the given type
         *
 
        /** \brief adds an error message with the given type
         *


@@ -218,25 +219,25 @@ public:                                                                   /*{{{*/
         * should call this method again in that case
         */
        bool Insert(MsgType type, const char* Description,
         * should call this method again in that case
         */
        bool Insert(MsgType type, const char* Description,

-                        va_list &args, size_t &msgSize) __cold;
+                        va_list &args, size_t &msgSize) APT_COLD;

 
        /** \brief is an error in the list?
         *
         *  \return \b true if an error is included in the list, \b false otherwise
         */
 
        /** \brief is an error in the list?
         *
         *  \return \b true if an error is included in the list, \b false otherwise
         */

-       inline bool PendingError() const {return PendingFlag;};
+       inline bool PendingError() const APT_PURE {return PendingFlag;};

 
        /** \brief is the list empty?
         *
 
        /** \brief is the list empty?
         *

-        *  The default checks if the list is empty or contains only notices,
-        *  if you want to check if also no notices happend set the parameter
-        *  flag to \b false.
+        *  Can be used to check if the current stack level doesn't include
+        *  anything equal or more severe than a given threshold, defaulting
+        *  to warning level for historic reasons.

         *
         *

-        *  \param WithoutNotice does notices count, default is \b true, so no
+        *  \param threshold minimum level considered

         *
         *

-        *  \return \b true if an the list is empty, \b false otherwise
+        *  \return \b true if the list is empty, \b false otherwise

         */
         */

-       bool empty(MsgType const &trashhold = WARNING) const;
+       bool empty(MsgType const &threshold = WARNING) const APT_PURE;

 
        /** \brief returns and removes the first (or last) message in the list
         *
 
        /** \brief returns and removes the first (or last) message in the list
         *


@@ -251,12 +252,11 @@ public:                                                                   /*{{{*/
 
        /** \brief outputs the list of messages to the given stream
         *
 
        /** \brief outputs the list of messages to the given stream
         *

-        *  Note that all messages are discarded, also the notices
-        *  displayed or not.
+        *  Note that all messages are discarded, even undisplayed ones.

         *
         *  \param[out] out output stream to write the messages in
         *
         *  \param[out] out output stream to write the messages in

-        *  \param threshold minimim level considered
-         *  \param mergeStack 
+        *  \param threshold minimum level considered
+        *  \param mergeStack if true recursively dumps the entire stack

         */
        void DumpErrors(std::ostream &out, MsgType const &threshold = WARNING,
                        bool const &mergeStack = true);
         */
        void DumpErrors(std::ostream &out, MsgType const &threshold = WARNING,
                        bool const &mergeStack = true);


@@ -302,7 +302,7 @@ public:                                                                     /*{{{*/
        void MergeWithStack();
 
        /** \brief return the deep of the stack */
        void MergeWithStack();
 
        /** \brief return the deep of the stack */

-       size_t StackCount() const {
+       size_t StackCount() const APT_PURE {

                return Stacks.size();
        }
 
                return Stacks.size();
        }
 


@@ -332,7 +332,7 @@ private:                                                            /*{{{*/
        bool PendingFlag;
 
        struct MsgStack {
        bool PendingFlag;
 
        struct MsgStack {

-               std::list<Item> const Messages;
+               std::list<Item> Messages;

                bool const PendingFlag;
 
                MsgStack(std::list<Item> const &Messages, bool const &Pending) :
                bool const PendingFlag;
 
                MsgStack(std::list<Item> const &Messages, bool const &Pending) :