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
11#ifndef RTC_BASE_LOCATION_H_
12#define RTC_BASE_LOCATION_H_
13
14#include <string>
15
16#include "rtc_base/stringize_macros.h"
17
18namespace rtc {
19
20// Location provides basic info where of an object was constructed, or was
21// significantly brought to life.
22// This is a stripped down version of:
23// https://code.google.com/p/chromium/codesearch#chromium/src/base/location.h
24class Location {
25 public:
26 // Constructor should be called with a long-lived char*, such as __FILE__.
27 // It assumes the provided value will persist as a global constant, and it
28 // will not make a copy of it.
29 //
30 // TODO(deadbeef): Tracing is currently limited to 2 arguments, which is
31 // why the file name and line number are combined into one argument.
32 //
33 // Once TracingV2 is available, separate the file name and line number.
34 Location(const char* function_name, const char* file_and_line);
35 Location();
36 Location(const Location& other);
37 Location& operator=(const Location& other);
38
39 const char* function_name() const { return function_name_; }
40 const char* file_and_line() const { return file_and_line_; }
41
42 std::string ToString() const;
43
44 private:
45 const char* function_name_;
46 const char* file_and_line_;
47};
48
49// Define a macro to record the current source location.
50#define RTC_FROM_HERE RTC_FROM_HERE_WITH_FUNCTION(__FUNCTION__)
51
52#define RTC_FROM_HERE_WITH_FUNCTION(function_name) \
53 ::rtc::Location(function_name, __FILE__ ":" RTC_STRINGIZE(__LINE__))
54
55} // namespace rtc
56
57#endif // RTC_BASE_LOCATION_H_
58