granicus.if.org Git - icinga2/blob - lib/base/debuginfo.hpp

   1 /******************************************************************************
   2  * Icinga 2                                                                   *
   3  * Copyright (C) 2012-2018 Icinga Development Team (https://www.icinga.com/)  *
   4  *                                                                            *
   5  * This program is free software; you can redistribute it and/or              *
   6  * modify it under the terms of the GNU General Public License                *
   7  * as published by the Free Software Foundation; either version 2             *
   8  * of the License, or (at your option) any later version.                     *
   9  *                                                                            *
  10  * This program is distributed in the hope that it will be useful,            *
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of             *
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the              *
  13  * GNU General Public License for more details.                               *
  14  *                                                                            *
  15  * You should have received a copy of the GNU General Public License          *
  16  * along with this program; if not, write to the Free Software Foundation     *
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.             *
  18  ******************************************************************************/
  19
  20 #ifndef DEBUGINFO_H
  21 #define DEBUGINFO_H
  22
  23 #include "base/i2-base.hpp"
  24 #include "base/string.hpp"
  25
  26 namespace icinga
  27 {
  28
  29 /**
  30  * Debug information for a configuration element.
  31  *
  32  * @ingroup config
  33  */
  34 struct DebugInfo
  35 {
  36         String Path;
  37
  38         int FirstLine{0};
  39         int FirstColumn{0};
  40
  41         int LastLine{0};
  42         int LastColumn{0};
  43 };
  44
  45 std::ostream& operator<<(std::ostream& out, const DebugInfo& val);
  46
  47 DebugInfo DebugInfoRange(const DebugInfo& start, const DebugInfo& end);
  48
  49 void ShowCodeLocation(std::ostream& out, const DebugInfo& di, bool verbose = true);
  50
  51 }
  52
  53 #endif /* DEBUGINFO_H */