xmltooling/util/NDC.h

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