/usr/include/pdal/Log.hpp is in libpdal-dev 1.4.0-1+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 | /******************************************************************************
* Copyright (c) 2011, Howard Butler, hobu.inc@gmail.com
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following
* conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided
* with the distribution.
* * Neither the name of Hobu, Inc. or Flaxen Geo Consulting nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
****************************************************************************/
#pragma once
#include <cassert>
#include <memory> // shared_ptr
#include <stack>
#include <pdal/pdal_internal.hpp>
// Adapted from http://drdobbs.com/cpp/201804215
namespace pdal
{
/// pdal::Log is a logging object that is provided by pdal::Stage to
/// facilitate logging operations.
class PDAL_DLL Log
{
public:
/// Constructs a pdal::Log instance.
/// @param leaderString A string to presage all log entries with
/// @param outputName A filename or one of 'stdout', 'stdlog', or 'stderr'
/// to use for outputting log information.
Log(std::string const& leaderString, std::string const& outputName);
/// Constructs a pdal::Log instance.
/// @param leaderString A string to presage all log entries with
/// @param v An existing std::ostream to use for logging (instead of the
/// the instance creating its own)
Log(std::string const& leaderString, std::ostream* v);
/** @name Destructor
*/
/// The destructor will clean up its own internal log stream, but it will
/// not touch one that is given via the constructor
~Log();
/** @name Logging level
*/
/// @return the logging level of the pdal::Log instance
LogLevel getLevel()
{
return m_level;
}
/// Sets the logging level of the pdal::Log instance
/// @param v logging level to use for get() comparison operations
void setLevel(LogLevel v)
{
assert(v != LogLevel::None);
m_level = v;
}
/// Set the leader string (deprecated).
/// \param[in] leader Leader string.
void setLeader(const std::string& leader)
{ pushLeader(leader); }
/// Push the leader string onto the stack.
/// \param leader Leader string
void pushLeader(const std::string& leader)
{ m_leaders.push(leader); }
/// Get the leader string.
/// \return The current leader string.
std::string leader() const
{ return m_leaders.empty() ? std::string() : m_leaders.top(); }
/// Pop the current leader string.
void popLeader()
{
if (!m_leaders.empty())
m_leaders.pop();
}
/// @return A string representing the LogLevel
std::string getLevelString(LogLevel v) const;
/** @name Log stream operations
*/
/// @return the stream object that is currently being used to for log
/// operations regardless of logging level of the instance.
std::ostream* getLogStream()
{
return m_log;
}
/// Returns the log stream given the logging level.
/// @param level logging level to request
/// If the logging level asked for with
/// pdal::Log::get is less than the logging level of the pdal::Log instance
std::ostream& get(LogLevel level = LogLevel::Info);
/// Sets the floating point precision
void floatPrecision(int level);
/// Clears the floating point precision settings of the streams
void clearFloat();
protected:
std::ostream *m_log;
std::ostream *m_nullStream;
private:
Log(const Log&);
Log& operator =(const Log&);
void makeNullStream();
LogLevel m_level;
bool m_deleteStreamOnCleanup;
std::stack<std::string> m_leaders;
};
typedef std::shared_ptr<Log> LogPtr;
} // namespace pdal
|