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. |
| 30 | // |
| 31 | // TODO(deadbeef): Tracing is currently limited to 2 arguments, which is |
| 32 | // why the file name and line number are combined into one argument. |
| 33 | // |
| 34 | // Once TracingV2 is available, separate the file name and line number. |
| 35 | Location(const char* function_name, const char* file_and_line); |
| 36 | Location(); |
| 37 | Location(const Location& other); |
| 38 | Location& operator=(const Location& other); |
| 39 | |
| 40 | const char* function_name() const { return function_name_; } |
| 41 | const char* file_and_line() const { return file_and_line_; } |
| 42 | |
| 43 | std::string ToString() const; |
| 44 | |
| 45 | private: |
| 46 | const char* function_name_; |
| 47 | const char* file_and_line_; |
| 48 | }; |
| 49 | |
| 50 | // Define a macro to record the current source location. |
| 51 | #define RTC_FROM_HERE RTC_FROM_HERE_WITH_FUNCTION(__FUNCTION__) |
| 52 | |
| 53 | #define RTC_FROM_HERE_WITH_FUNCTION(function_name) \ |
| 54 | ::rtc::Location(function_name, __FILE__ ":" STRINGIZE(__LINE__)) |
| 55 | |
| 56 | } // namespace rtc |
Taylor Brandstetter | 5d97a9a | 2016-06-10 14:17:27 -0700 | [diff] [blame] | 57 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 58 | #endif // RTC_BASE_LOCATION_H_ |