Log.h

Go to the documentation of this file.

// Copyright 2016 Sensics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//  http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef INCLUDED_Log_h_GUID_B6053E2B_593D_4ECA_8C3B_2C55D0FE6A49
#define INCLUDED_Log_h_GUID_B6053E2B_593D_4ECA_8C3B_2C55D0FE6A49

// Internal Includes
#include <osvr/Util/Export.h>
#include <osvr/Util/SharedPtr.h>
#include <osvr/Util/UniquePtr.h>

// Library/third-party includes
// - none

// Standard includes
#include <string>

#undef OSVR_USE_UNIQUEPTR_FOR_LOGGER

namespace osvr {
namespace util {
    namespace log {
        class Logger;
#ifdef OSVR_USE_UNIQUEPTR_FOR_LOGGER
        typedef unique_ptr<Logger> LoggerPtr;
        typedef shared_ptr<Logger> LoggerSharedPtr;
#else
        typedef shared_ptr<Logger> LoggerPtr;
#endif

        OSVR_UTIL_EXPORT bool
        tryInitializingLoggingWithBaseName(std::string const &baseName);

        OSVR_UTIL_EXPORT LoggerPtr make_logger(const std::string &logger_name);

        OSVR_UTIL_EXPORT void drop(const std::string &logger_name);

        OSVR_UTIL_EXPORT void dropAll();

        OSVR_UTIL_EXPORT void flush();

        OSVR_UTIL_EXPORT std::string getLoggingDirectory(bool make_dir = false);

    } // end namespace log
} // end namespace util
} // end namespace osvr

#endif // INCLUDED_Log_h_GUID_B6053E2B_593D_4ECA_8C3B_2C55D0FE6A49