locationinfo.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 _LOG4CXX_SPI_LOCATION_LOCATIONINFO_H
#define _LOG4CXX_SPI_LOCATION_LOCATIONINFO_H

#include <log4cxx/log4cxx.h>
#include <string>
#include <log4cxx/helpers/objectoutputstream.h>

#if __cpp_lib_string_view || (_MSVC_LANG >= 201703L)
#include <string_view>
#define LOG4CXX_HAS_STRING_VIEW
#else
#include <string.h>
#endif

#if defined(_WIN32)
#define LOG4CXX_SHORT_FILENAME_SPLIT_CHAR '\\'
#else
#define LOG4CXX_SHORT_FILENAME_SPLIT_CHAR '/'
#endif

namespace log4cxx
{
namespace spi
{
class LOG4CXX_EXPORT LocationInfo
{
    public:



        static const char* const NA;
        static const char* const NA_METHOD;

        static const LocationInfo& getLocationUnavailable();

#ifdef LOG4CXX_HAS_STRING_VIEW
        static constexpr const char* calcShortFileName(const char* fileName){
            std::string_view view(fileName);
            // If the separator is not found, rfind will return -1.  Adding 1 to
            // that will have it pointing at fileName, which is a good fallback.
            return fileName + view.rfind(LOG4CXX_SHORT_FILENAME_SPLIT_CHAR) + 1;
        }
#else
        static const char* calcShortFileName(const char* fileName){
            const char* location = strrchr(fileName, LOG4CXX_SHORT_FILENAME_SPLIT_CHAR);
            return location == nullptr ? fileName : location + 1;
        }
#endif

        LocationInfo( const char* const fileName,
                      const char* const shortFileName,
                      const char* const functionName,
                      int lineNumber);

        LocationInfo();

        LocationInfo( const LocationInfo& src );

        LocationInfo& operator = ( const LocationInfo& src );

        void clear();


        const std::string getClassName() const;

        const char* getFileName() const;

        const char* getShortFileName() const;

        int getLineNumber() const;

        const std::string getMethodName() const;

        void write(log4cxx::helpers::ObjectOutputStream& os, log4cxx::helpers::Pool& p) const;


    private:
        int lineNumber;

        const char* fileName;

        const char* shortFileName;

        const char* methodName;


};
}
}

#if !defined(LOG4CXX_LOCATION) && !LOG4CXX_DISABLE_LOCATION_INFO
#if defined(_MSC_VER)
    #if _MSC_VER >= 1300
        #define __LOG4CXX_FUNC__ __FUNCSIG__
    #endif
#else
    #if defined(__GNUC__)
        #define __LOG4CXX_FUNC__ __PRETTY_FUNCTION__
    #else
        #if defined(__BORLANDC__)
            #define __LOG4CXX_FUNC__ __FUNC__
        #endif
    #endif
#endif
#if !defined(__LOG4CXX_FUNC__)
    #define __LOG4CXX_FUNC__ ""
#endif


#define LOG4CXX_LOCATION ::log4cxx::spi::LocationInfo(__FILE__,         \
    ::log4cxx::spi::LocationInfo::calcShortFileName(__FILE__), \
    __LOG4CXX_FUNC__, \
    __LINE__)

#else
#define LOG4CXX_LOCATION ::log4cxx::spi::LocationInfo::getLocationUnavailable()
#endif // LOG4CXX_LOCATION

#endif //_LOG4CXX_SPI_LOCATION_LOCATIONINFO_H