osbmsgcat.h

Go to the documentation of this file.

// OSB library ************************************************ -*- C++ -*-
/*
  AUTHOR(S): Stephan Broennimann (vb)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.7 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file is distributed in the hope that it will be useful, but WITHOUT
   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
   for more details.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */
#ifndef _OSBMSGCAT_H_
#define _OSBMSGCAT_H_

// ************************************************************************
// included header files
// + standard includes
#include <map>

// + libraries

// + local headers
#include "osberror.h"
#include "mutex.h"

// + class declarations

// ************************************************************************
// namespace extensions
namespace OSB_LIB {

// ************************************************************************
// forward declarations
    class ErrList;

// ************************************************************************
// type definitions

// ************************************************************************
// class definitions

    class MsgCat {
    public:
        struct Init {
            Init(bool useLocks);
        };                              // struct Init
        friend struct Init;

    public:
        static void useLocks();

        static void msg(
            const BaseError&   e,
                  std::string& dest
        );

        static MsgCat& instance();

    public:
        void mkMsg(
            const BaseError&   e,
                  std::string& dest
        );

    private:
        MsgCat();
        ~MsgCat();
        MsgCat(const MsgCat&);

    private:
        Guard lock();
        ErrList& errList(const BaseError& e);

    private:
        typedef std::map<std::string, ErrList*> ErrLists;

        bool useLocks_;
        Mutex mutex_;
        MutexUnlock unlock_;
        ErrLists errLists_;

    private:
        struct Destroy {
            ~Destroy();
        };                              // struct Destroy
        friend struct Destroy;

    private:
        static Destroy destroy_;
        static MsgCat* instance_;
    };                                  // class MsgCat

    class ErrList {
        friend class MsgCat;
    public:
        const std::string& errMsg() const
        {
            return errMsg_;
        }

        bool mkErrorMsg(
                  std::string&       dest,
                  BaseError::ErrorNo errNo,
            const BaseError::Args&   errArgs
        ) const;

    private:
        typedef std::vector<std::string> BaseText;
        typedef std::map<BaseError::ErrorNo, BaseText> TextMap;

        ErrList(const std::string& filename);
        ErrList(const ErrList&);
        ErrList& operator=(const ErrList&);

        void separate(
                  BaseText&    dest,
            const std::string& errStr
        );

        const BaseText* getText(OsbBaseError::ErrorNo errNo) const;

        void compose(
                  std::string&     dest,
            const BaseText&        text,
            const BaseError::Args& errArgs
        ) const;

        void compose(
                  std::string&     dest,
            const std::string&     errMsg,
            const BaseError::Args& errArgs
        ) const;

        TextMap textMap_;
        std::string errMsg_;
    };                                  // class ErrList
}                                       // namespace OSB_LIB

// ************************************************************************
// inline definitions
namespace OSB_LIB {
}                                       // namespace OSB_LIB
#endif                                  // #ifndef _OSBMSGCAT_H_

---