xmltooling/util/NDC.h

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * @file xmltooling/util/NDC.h
  23  *
  24  * Diagnostic context for logging
  25  */
  26
  27 #ifndef __xmltooling_ndc_h__
  28 #define __xmltooling_ndc_h__
  29
  30 #include <xmltooling/base.h>
  31
  32 #include <string>
  33
  34 namespace xmltooling {
  35
  36     /**
  37      * A portable stack-based context for diagnostic logging
  38      */
  39     class XMLTOOL_API NDC
  40     {
  41     MAKE_NONCOPYABLE(NDC);
  42     public:
  43         /**
  44          * Constructor pushes logging context onto diagnostic stack
  45          * @param context   null-terminated label for context
  46          */
  47         NDC(const char* context);
  48
  49         /**
  50          * Constructor pushes logging context onto diagnostic stack
  51          * @param context   string label for context
  52          */
  53         NDC(const std::string& context);
  54
  55         /**
  56          * Destructor pops context off of diagnostic stack
  57          */
  58         ~NDC();
  59     };
  60
  61 };
  62
  63 #endif /* __xmltooling_ndc_h__ */