Taylor Brandstetter | 5d97a9a | 2016-06-10 14:17:27 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 The WebRTC Project Authors. All rights reserved. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license |
| 5 | * that can be found in the LICENSE file in the root of the source |
| 6 | * tree. An additional intellectual property rights grant can be found |
| 7 | * in the file PATENTS. All contributing project authors may |
| 8 | * be found in the AUTHORS file in the root of the source tree. |
| 9 | */ |
| 10 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef RTC_BASE_LOCATION_H_ |
| 12 | #define RTC_BASE_LOCATION_H_ |
Taylor Brandstetter | 5d97a9a | 2016-06-10 14:17:27 -0700 | [diff] [blame] | 13 | |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 14 | #include <string> |
Taylor Brandstetter | 5d97a9a | 2016-06-10 14:17:27 -0700 | [diff] [blame] | 15 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 16 | #include "rtc_base/stringize_macros.h" |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 17 | #include "rtc_base/system/rtc_export.h" |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 18 | |
| 19 | namespace rtc { |
| 20 | |
| 21 | // Location provides basic info where of an object was constructed, or was |
| 22 | // significantly brought to life. |
| 23 | // This is a stripped down version of: |
| 24 | // https://code.google.com/p/chromium/codesearch#chromium/src/base/location.h |
Mirko Bonadei | 35214fc | 2019-09-23 14:54:28 +0200 | [diff] [blame] | 25 | class RTC_EXPORT Location { |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 26 | public: |
| 27 | // Constructor should be called with a long-lived char*, such as __FILE__. |
| 28 | // It assumes the provided value will persist as a global constant, and it |
| 29 | // will not make a copy of it. |
Steve Anton | c5d7c52 | 2019-12-03 10:14:05 -0800 | [diff] [blame] | 30 | Location(const char* function_name, const char* file_name, int line_number) |
| 31 | : function_name_(function_name), |
| 32 | file_name_(file_name), |
| 33 | line_number_(line_number) {} |
| 34 | Location() = default; |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 35 | |
| 36 | const char* function_name() const { return function_name_; } |
Steve Anton | c5d7c52 | 2019-12-03 10:14:05 -0800 | [diff] [blame] | 37 | const char* file_name() const { return file_name_; } |
| 38 | int line_number() const { return line_number_; } |
| 39 | // TODO(steveanton): Remove once all downstream users have been updated to use |
| 40 | // |file_name()| and/or |line_number()|. |
| 41 | const char* file_and_line() const { return file_name_; } |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 42 | |
| 43 | std::string ToString() const; |
| 44 | |
| 45 | private: |
Steve Anton | c5d7c52 | 2019-12-03 10:14:05 -0800 | [diff] [blame] | 46 | const char* function_name_ = "Unknown"; |
| 47 | const char* file_name_ = "Unknown"; |
| 48 | int line_number_ = -1; |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 49 | }; |
| 50 | |
| 51 | // Define a macro to record the current source location. |
| 52 | #define RTC_FROM_HERE RTC_FROM_HERE_WITH_FUNCTION(__FUNCTION__) |
| 53 | |
| 54 | #define RTC_FROM_HERE_WITH_FUNCTION(function_name) \ |
Steve Anton | c5d7c52 | 2019-12-03 10:14:05 -0800 | [diff] [blame] | 55 | ::rtc::Location(function_name, __FILE__, __LINE__) |
Henrik Kjellander | ec78f1c | 2017-06-29 07:52:50 +0200 | [diff] [blame] | 56 | |
| 57 | } // namespace rtc |
Taylor Brandstetter | 5d97a9a | 2016-06-10 14:17:27 -0700 | [diff] [blame] | 58 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 59 | #endif // RTC_BASE_LOCATION_H_ |