xmltooling/util/NDC.h

   1 /*
   2  *  Copyright 2001-2007 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 NDC.h
  19  *
  20  * Diagnostic context for logging
  21  */
  22
  23 #if !defined(__xmltooling_ndc_h__)
  24 #define __xmltooling_ndc_h__
  25
  26 #include <string>
  27 #include <xmltooling/base.h>
  28
  29 namespace xmltooling {
  30
  31     /**
  32      * A portable stack-based context for diagnostic logging
  33      */
  34     class XMLTOOL_API NDC
  35     {
  36     public:
  37         /**
  38          * Constructor pushes logging context onto diagnostic stack
  39          * @param context   null-terminated label for context
  40          */
  41         NDC(const char* context);
  42
  43         /**
  44          * Constructor pushes logging context onto diagnostic stack
  45          * @param context   string label for context
  46          */
  47         NDC(const std::string& context);
  48
  49         /**
  50          * Destructor pops context off of diagnostic stack
  51          */
  52         ~NDC();
  53
  54     MAKE_NONCOPYABLE(NDC);
  55     };
  56
  57 };
  58
  59 #endif /* __xmltooling_ndc_h__ */